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.0.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ccmm_invenio-2.0.4.tar.gz | 919.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ccmm_invenio-2.0.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 2.0 MB
Release files / ccmm_invenio-2.0.4.tar.gz
| Download URL | ccmm_invenio-2.0.4.tar.gz |
|---|---|
| Size | 919.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a3ba9eb7d98ff5c8980948e6e9918730f2329274f26bfd3582c4b2d8bc32d7d5
|
|
BLAKE2b-256 checksum How to use checksums |
24bc67e0a5e38a53312af4a958c8218521ba863602e17a51280a2e731bf0283d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / ccmm_invenio-2.0.4-py3-none-any.whl
| Download URL | ccmm_invenio-2.0.4-py3-none-any.whl |
|---|---|
| Size | 1.0 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
474cb00755219e1836792df308d00b5544ed5c8df9ad4d441dddb484cace71e5
|
|
BLAKE2b-256 checksum How to use checksums |
af37372bec7dad6f93bdeb0c5a1a2606c511cf59a0b78c121027aac550b045e7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|