Attention

This project is still in an early phase of development.

The python API is not yet stable, and some aspects of the schema for the blueprint and workplan will likely evolve. Therefore whilst you are welcome to try out using the package, we cannot yet guarantee backwards compatibility. We expect to reach a more stable version in 2026.

CodeRepository

class cstar.orchestration.models.CodeRepository(*, documentation: str = '', locked: bool = False, location: HttpUrl | str, commit: str = '', branch: str = '', filter: PathFilter | None = None)

Bases: DocLocMixin, ConfiguredBaseModel

Reference to a remote code repository with optional path filtering and point-in-time specification.

Attributes

CodeRepository.checkout_target	Return the commit if specified, else the branch
CodeRepository.location	Location of the remote code repository.
CodeRepository.commit	A specific commit to be used.
CodeRepository.branch	A specific branch to be used.
CodeRepository.filter	A filter specifying the files to be retrieved and persisted from the repository.
CodeRepository.documentation	Description of input data provenance; used in provenance roll-up.
CodeRepository.locked	Mutability of the parameter set.