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.

Step

class cstar.orchestration.models.Step(*, name: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=True, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None, ascii_only=None)], application: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=True, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None, ascii_only=None)], blueprint: ~typing.Annotated[~pathlib.Path, ~pydantic.types.PathType(path_type=file)] | str, depends_on: list[~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=True, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None, ascii_only=None)]] = <factory>, blueprint_overrides: dict[str, str | float | list[str] | list[float] | dict[str, ~typing.Any]] = <factory>, compute_overrides: dict[str, str | float | list[str] | list[float] | dict[str, ~typing.Any]] = <factory>, workflow_overrides: dict[str, str | float | list[str] | list[float] | dict[str, ~typing.Any]] = <factory>, directives: dict[str, str | float | list[str] | list[float] | dict[str, ~typing.Any]] = <factory>)

Bases: BaseModel

An individual unit of execution within a workplan.

Attributes

Step.safe_name	Return a URL-safe version of the step name.
Step.name	The user-friendly name of the step.
Step.application	The user-friendly name of the application executed in the step.
Step.blueprint_path	The blueprint that will be executed in this step.
Step.depends_on	An optional list of external step names that must execute prior to this step.
Step.blueprint_overrides	A collection of key-value pairs specifying overrides for blueprint attributes.
Step.compute_overrides	A collection of key-value pairs specifying overrides for compute attributes.
Step.workflow_overrides	A collection of key-value pairs specifying overrides for workflow attributes.
Step.directives	A collection of key-value pairs specifying configuration for runtime directives.