Skip to main content

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.3.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ccmm-invenio 2.3.1
File Size Uploaded Provenance Actions
ccmm_invenio-2.3.1.tar.gz 1.0 MB Without provenance Details for ccmm_invenio-2.3.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ccmm-invenio 2.3.1
File Interpreter ABI Platform Actions
ccmm_invenio-2.3.1-py3-none-any.whl Python 3 none any Details for ccmm_invenio-2.3.1-py3-none-any.whl

Total release size: 2.2 MB

Release files / ccmm_invenio-2.3.1.tar.gz

Download URL ccmm_invenio-2.3.1.tar.gz
Size 1.0 MB
Tags Source
SHA-256 checksum
How to use checksums
bf49d0a2dc36f1b05a978a61919485057518be4873785aa8a7e98aeef5a36903
BLAKE2b-256 checksum
How to use checksums
aa43e02ee93c537c377c1c277b00b835ac3e86500ba8224038940c9ec33981eb
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.3.1-py3-none-any.whl

Download URL ccmm_invenio-2.3.1-py3-none-any.whl
Size 1.2 MB
Tags Python 3
SHA-256 checksum
How to use checksums
329467806bd9783f9bc2ed0b4e9ae4fd03ead97272953b33611bd780ef871ad2
BLAKE2b-256 checksum
How to use checksums
f461e21784ceb3be19650e821a263db26aa0dacb2150e39ee91c58fbe233b2f2
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.3.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.

Release history Release notifications | RSS feed

This release

2.3.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page