Getting started
Prerequisites
Section titled “Prerequisites”- Python 3.10 or later
- uv package manager
Installation
Section titled “Installation”Clone the repository and install dependencies:
git clone https://github.com/dharc-org/changes-metadata-manager.gitcd changes-metadata-manageruv syncInput data
Section titled “Input data”The tool expects two things to be in place before you run it:
-
A knowledge graph in Turtle format at
data/kg.ttl. This file is generated by morph-kgc-changes-metadata and contains all the RDF triples describing the digitized objects. -
A folder structure following the pattern
Sala*/Folder/Stage/on the local filesystem. See the digitization stages page for what each stage represents.
Quick start
Section titled “Quick start”Once you have the knowledge graph and the folder structure, generate metadata and provenance for all objects:
uv run python -m changes_metadata_manager.folder_metadata_builder /path/to/rootEach stage folder will receive:
meta.ttl: RDF metadata extracted from the knowledge graphprov.trig: provenance snapshots in TriG format
Running tests
Section titled “Running tests”uv run pytestWith coverage reporting:
uv run pytest --cov=changes_metadata_manager --cov-report=termWhat next
Section titled “What next”- Folder metadata builder for the full set of options
- Zenodo upload to package and publish datasets
- SharePoint sync if you need to pull files from SharePoint
- Architecture for an overview of how the pieces fit together