Skip to content

trudag.trustable_project

TrustableProject 

TrustableProject(
    project: Path,
    configuration: TrustableOptions,
    db: Path | None = None,
)

Represents a Trustable project which consists of the .dotstop.dot and .needs.dot files and the corresponding item files.

Creates or opens a project.

Parameters:

Name Type Description Default
project Path

Create or open a project directory at the path provided.

 required
db Path | None

Path relative to project directory which contains item files, defaults to "db".

 None
artifact

Path relative to project directory to output an exported artifact to, defaults to creating a JSON file with the provided project name in the project directory.

 required
name

The project name used when creating a graph in the dotstop file or when exporting an artifact, defaults to the same name given to the project directory.

 required