Python API

velocity.build(targets: str, name: str = None, dry_run: bool = False, leave_tags: bool = False, verbose: bool = False, clean: bool = False) → None

Build an image.

Parameters:

• targets (str) – A string of build targets e.g. ‘gcc@12.4 rocm@5’.

• name (str) – Name of complete image.

• dry_run (bool) – Dry run build system.

• leave_tags (bool) – Do not clean up intermediate build tags (only applies to dockerish backends).

• verbose (bool) – Print helpful debug/runtime information.

• clean (bool) – Remove cached files in the build directory.

velocity.get_backend() → str

Get the backend.

Returns:

The current backend.

Return type:

str

velocity.get_distro() → str

Get the distro.

Returns:

The current distro.

Return type:

str

velocity.get_system() → str

Get the system.

Returns:

The current system.

Return type:

str

velocity.set_backend(backend: str) → None

Set the backend.

Parameters:

backend (str) – New value for backend.

velocity.set_distro(distro: str) → None

Set the distro.

Parameters:

distro (str) – New value for distro.

velocity.set_system(system: str) → None

Set the system.

Parameters:

system (str) – New value for system.