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.

StagedData

class cstar.io.staged_data.StagedData(source: SourceData, path: Path)

Bases: ABC

Class to track locally staged data (files, repositories, etc.)

source(SourceData)

The SourceData instance describing the source of the staged data.

path(pathlib.Path)

The local path to the location of the staged data

changed_from_source(bool)

True if the data have been modified since staging

unstage:

Remove staged version of this data from path.

reset:

Revert to original staged state if changed_from_source.

Methods

StagedData.reset()	Revert to original staged state if changed_from_source.
StagedData.unstage()	Remove staged local filesystem version of this data

Attributes

StagedData.changed_from_source	True if the data have been modified since staging
StagedData.path	The local path to the staged data
StagedData.source	The SourceData describing the source of the staged data.