makeprov.config

Functions

`dataclass`([cls, init, repr, eq, order, ...])	Add dunder methods based on the fields defined in the class.
`fields`(class_or_instance)	Return a tuple describing the fields of this dataclass.
`is_dataclass`(obj)	Returns True if obj is a dataclass or an instance of a dataclass.
`main`([subcommands, conf_obj, ...])	Entry point for running registered CLI subcommands.
`replace`(obj, /, **changes)	Return a new object replacing specified fields with new values.

Classes

`Config`()	Base configuration container with TOML application helpers.
`ProvenanceConfig`([base_iri, prov_dir, ...])	Runtime configuration for provenance generation.

class makeprov.config.Config

Bases: object

Base configuration container with TOML application helpers.

apply(toml_ref)

Return type:: Config

clone_with(**kwargs)

Return type:: Config

classmethod get()

Return type:: Config

classmethod set(config)

Return type:: Config

class makeprov.config.ProvenanceConfig(base_iri=None, prov_dir='prov', prov_path=None, force=False, merge=True, stream=False, dry_run=False, out_fmt='json', frame='provenance', context=False, context_url='https://w3id.org/makeprov/context', strict=True, run_id=None, record_user=False, record_environment=False, forge_profiles=None, emit_plan_graph=False)

Bases: Config

Runtime configuration for provenance generation.

base_iri: str | None = None

context: bool = False

context_url: str = 'https://w3id.org/makeprov/context'

dry_run: bool = False

emit_plan_graph: bool = False

force: bool = False

forge_profiles: str | None = None

frame: Frame = 'provenance'

merge: bool = True

out_fmt: ProvFormat = 'json'

prov_dir: str = 'prov'

prov_path: str | None = None

record_environment: bool = False

record_user: bool = False

run_id: str | None = None

stream: bool = False

strict: bool = True

makeprov.config.main(subcommands=None, conf_obj=None, argparse_kwargs={}, *, session=None, **kwargs)

Entry point for running registered CLI subcommands.

Requires the defopt package (install with pip install "makeprov[cli]"), imported lazily here so that import makeprov does not require it.