cstar.io.source_data.SourceDataCollection.from_common_location

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.

cstar.io.source_data.SourceDataCollection.from_common_location#

classmethod SourceDataCollection.from_common_location(common_location: str, subdir: str = '', checkout_target: str = '', files: Iterable[str] = ()) → SourceDataCollection#

Create a SourceDataCollection automatically by inspecting the contents of a common location.

Parameters:

  • common_location (str) – The common location to inspect.

  • subdir (str) – The subdirectory to inspect.

  • checkout_target (str) – The checkout target to use for remote repositories.

  • files (Iterable[str]) – The files to inspect.

Returns:

SourceDataCollection – A SourceDataCollection containing the specified files.

Raises:

ValueError – If the common location is not a remote repository or local directory.