blext.cli
blext.cli.__main__
Entrypoint of the cli
package.
Notes
This allows blext
to be run using python -m blext.cli
.
blext.cli._entrypoint
blext *
blext.cli._context
Shared context for blext
commands.
blext.cli.build
Implements blext build
.
build
build(
proj: ParameterProj = None,
*,
blext_info: ParameterBLExtInfo = DEFAULT_BLEXT_INFO,
global_config: ParameterConfig = DEFAULT_CONFIG,
output: Path | None = None,
overwrite: bool = True,
vendor: bool = True,
check_output: bool = True,
) -> None
Build an extension project.
PARAMETER | DESCRIPTION |
---|---|
proj
|
Location specifier for
TYPE:
|
blext_info
|
Information used to find and load
TYPE:
|
global_config
|
Loaded global configuration.
TYPE:
|
output
|
Write built extension to this file / folder.
TYPE:
|
overwrite
|
Allow overwriting
TYPE:
|
vendor
|
Include dependencies as wheels in the
TYPE:
|
check_output
|
Run
TYPE:
|
Source code in blext/cli/build.py
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 |
|
blext.cli.check
Implements blext check
.
check
check(
proj: ParameterProj = None,
*,
blext_info: ParameterBLExtInfo = DEFAULT_BLEXT_INFO,
global_config: ParameterConfig = DEFAULT_CONFIG,
) -> None
Check an extension project for problems.
PARAMETER | DESCRIPTION |
---|---|
proj
|
Location specifier for
TYPE:
|
blext_info
|
Information used to find and load
TYPE:
|
global_config
|
Loaded global configuration.
TYPE:
|
Source code in blext/cli/check.py
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 |
|
blext.cli.run
Implements blext dev
.
run
run(
proj: ParameterProj = None,
*,
blext_info: ParameterBLExtInfo = DEFAULT_BLEXT_INFO,
global_config: ParameterConfig = DEFAULT_CONFIG,
blend: Path | None = None,
headless: bool = False,
factory_startup: bool = True,
) -> None
Run an extension live in Blender.
PARAMETER | DESCRIPTION |
---|---|
proj
|
Location specifier for
TYPE:
|
blext_info
|
Information used to find and load
TYPE:
|
global_config
|
Loaded global configuration.
TYPE:
|
blend
|
TYPE:
|
headless
|
Run Blender without a GUI.
TYPE:
|
factory_startup
|
Run Blender with default "factory settings".
TYPE:
|
Source code in blext/cli/run.py
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 |
|
blext show
blext.cli._context_show
Shared context for blext show
commands.
blext.cli.show_blender_manifest
Implements blext show blender_manifest
.
show_blender_manifest
show_blender_manifest(
proj: ParameterProj = None,
*,
blext_info: ParameterBLExtInfo = DEFAULT_BLEXT_INFO,
global_config: ParameterConfig = DEFAULT_CONFIG,
format: Literal['json', 'toml'] = 'toml',
) -> None
Print the complete extension specification.
PARAMETER | DESCRIPTION |
---|---|
proj
|
Location specifier for
TYPE:
|
blext_info
|
Information used to find and load
TYPE:
|
global_config
|
Loaded global configuration.
TYPE:
|
format
|
The text format to show the Blender manifest as.
TYPE:
|
Source code in blext/cli/show_blender_manifest.py
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 |
|
blext.cli.show_global_config
Implements blext show config
.
show_global_config
show_global_config(
*,
format: Literal['raw', 'json', 'toml'] = 'toml',
config: ParameterConfig = DEFAULT_CONFIG,
) -> None
Inspect all Python dependencies.
PARAMETER | DESCRIPTION |
---|---|
format
|
Column to sort dependencies by.
TYPE:
|
config
|
Global configuration overrides.
TYPE:
|
Source code in blext/cli/show_global_config.py
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
|
blext.cli.show_deps
Implements blext show deps
.
show_deps
show_deps(
proj: ParameterProj = None,
*,
blext_info: ParameterBLExtInfo = DEFAULT_BLEXT_INFO,
global_config: ParameterConfig = DEFAULT_CONFIG,
sort_by: Literal['filename', 'size'] = 'filename',
format: Literal['table'] = 'table',
) -> None
Inspect all Python dependencies.
PARAMETER | DESCRIPTION |
---|---|
proj
|
Location specifier for
TYPE:
|
blext_info
|
Information used to find and load
TYPE:
|
global_config
|
Loaded global configuration.
TYPE:
|
sort_by
|
Column to sort dependencies by.
TYPE:
|
format
|
Text format to output.
TYPE:
|
Source code in blext/cli/show_deps.py
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 |
|
blext.cli.show_profile
Implements blext show init_settings
.
show_profile
show_profile(
proj: ParameterProj = None,
*,
blext_info: ParameterBLExtInfo = DEFAULT_BLEXT_INFO,
global_config: ParameterConfig = DEFAULT_CONFIG,
format: Literal['json', 'toml'] = 'toml',
) -> None
Show release-profile settings.
PARAMETER | DESCRIPTION |
---|---|
proj
|
Location specifier for
TYPE:
|
blext_info
|
Information used to find and load
TYPE:
|
global_config
|
Loaded global configuration.
TYPE:
|
format
|
Text format to output.
TYPE:
|
Source code in blext/cli/show_profile.py
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 |
|
blext show path
blext.cli._context_show_path
Shared context for blext show path
commands.
blext.cli.show_path_blender
Implements show path blender
.
show_path_blender
show_path_blender(
*, global_config: ParameterConfig = DEFAULT_CONFIG
) -> None
Path to the blender
executable used by blext
.
Source code in blext/cli/show_path_blender.py
29 30 31 32 33 34 35 |
|
blext.cli.show_path_uv
Implements blext show path uv
.
show_path_uv
show_path_uv(
*, global_config: ParameterConfig = DEFAULT_CONFIG
) -> None
Path to uv
executable used by blext
.
Source code in blext/cli/show_path_uv.py
29 30 31 32 33 34 35 |
|