CCMM-Invenio: CCMM runtime library for NRP Invenio
This library provides:
- an OARepo model preset for CCMM datasets (
ccmm_preset_1_1_0) - CCMM XML import and export (REST, OAI-PMH)
- vocabulary fixtures for the CCMM model
- UI components for working with the CCMM model in NRP Invenio
Installation
pip install ccmm-invenio
Usage
To use CCMM in a repository, add the following model:
# models/datasets.py
from ccmm_invenio.models import ccmm_preset_1_1_0
ccmm_dataset = model(
"ccmm_dataset",
version="1.1.0",
presets=[
ccmm_preset_1_1_0,
],
configuration={
# "ui_blueprint": "myui
},
types=[
{
"Metadata": {
"properties": {
# your extensions come here, ccmm_preset_1_1_0 will add
# all ccmm fields automatically
},
},
}
],
metadata_type="Metadata",
customizations=[],
)
# invenio.cfg
ccmm_dataset.register()
ccmm_production_preset_1_1_0 is an alias of ccmm_preset_1_1_0.
The preset adds the CCMM XML import and export (application/vnd.ccmm+xml,
also OAI-PMH with the ccmm metadata prefix). See AGENTS.md for the design of the
model and of the CCMM conversion.
How to adapt to a new CCMM version
Download and pre-process CCMM XML
Follow the instructions in ccmm_versions/README.md to download and pre-process
the CCMM XML schemas for the desired version. This will create:
- Cleaned XSD files in
ccmm_versions/src/ccmm_versions/ccmm-<version>-<date>/out - A diff file in
ccmm_versions/diffs/comparing the new version to the previous one - A schema overview in
ccmm_versions/summaries/ccmm-<version>-<date>.summary.md
Adapt the model yaml files
Copy the model in src/ccmm_invenio/models/<previous-version>-<date>/ to
src/ccmm_invenio/models/<new-version>-<date>/.
Look at the diff file generated in the previous step and adapt the
ccmm.yaml (the CCMM types used by the model), ccmm-invenio.yaml (the dataset, RDM based)
and ccmm-vocabularies.yaml files in src/ccmm_invenio/models/<version>-<date>/ accordingly.
Then add the new version to src/ccmm_invenio/models/__init__.py, the new XSD to
src/ccmm_invenio/resources/serializers/ccmm/xsd/ (updating the path in
converter.py) and adapt the marshmallow schemas in
src/ccmm_invenio/resources/serializers/ccmm/schema/.
Metadata
Release files for ccmm-invenio 2.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| ccmm_invenio-2.2.1.tar.gz | 1.0 MB | Without provenance | Details for ccmm_invenio-2.2.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| ccmm_invenio-2.2.1-py3-none-any.whl | Python 3 | none | any | Details for ccmm_invenio-2.2.1-py3-none-any.whl |
Total release size: 2.2 MB
Release files / ccmm_invenio-2.2.1.tar.gz
| Download URL | ccmm_invenio-2.2.1.tar.gz |
|---|---|
| Size | 1.0 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fd7f79da6a6143465503e72f1d509b4d88b45b9d881386be346de630339abffc
|
|
BLAKE2b-256 checksum How to use checksums |
b20ab9ea79cf6cae6f7f7a6c2619de60daead02266a1cda76e5170752e99d7aa
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Release files / ccmm_invenio-2.2.1-py3-none-any.whl
| Download URL | ccmm_invenio-2.2.1-py3-none-any.whl |
|---|---|
| Size | 1.2 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
fe232f82d6ba49a10867643623b064fe5f087e09336b855c7f8da940cdcad3c6
|
|
BLAKE2b-256 checksum How to use checksums |
ee09f8ab91af27ee3665a57a89b26f6f05397ff002809024c34bfb1e847526c5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Security for ccmm-invenio 2.2.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.