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

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.0.5
File Size Uploaded
ccmm_invenio-2.0.5.tar.gz 919.5 kB Details

Built distribution (wheel)

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

Total release size: 2.0 MB

Release files / ccmm_invenio-2.0.5.tar.gz

Download URL ccmm_invenio-2.0.5.tar.gz
Size 919.5 kB
Tags Source
SHA-256 checksum
How to use checksums
838d5bdd481f3942804b60f055a0d8107f1af115432e726687d707f1e540fbe2
BLAKE2b-256 checksum
How to use checksums
144bd39dc9243353a60dc66c5dd2b9056c17e986dacd8f16a44e9a0b6412ed91
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.5-py3-none-any.whl

Download URL ccmm_invenio-2.0.5-py3-none-any.whl
Size 1.0 MB
Tags Python 3
SHA-256 checksum
How to use checksums
b2c733be24fabc005cd1d5c2b78b01a4f7a7d418e70657864c6bf88b860771c6
BLAKE2b-256 checksum
How to use checksums
06772cfc26bd4b9022f3255d76ffc10da623a28c85388736d98395a3182476cd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release history Release notifications | RSS feed

This release

2.0.5 This release

2 release files

2.0.4

2 release files

2.0.3

2 release files

2.0.2

2 release files

2.0.1

2 release files

2.0.0

2 release files

1.1.27

2 release files

1.1.26

2 release files

1.1.25

2 release files

1.1.24

2 release files

1.1.23

2 release files

1.1.21

2 release files

1.1.18

2 release files

1.1.17

2 release files

1.1.16

2 release files

1.1.15

2 release files

1.1.14

2 release files

1.1.13

2 release files

1.1.10

2 release files

1.1.9

2 release files

1.1.8

2 release files

1.1.7

2 release files

1.1.6

2 release files

1.1.5

2 release files

1.1.4

2 release files

1.1.3

2 release files

1.1.2

2 release files

1.1.1

2 release files

1.1.0

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.0

2 release files

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