commonmeta-py 0.222

Library for conversions to/from the Commonmeta scholarly metadata format

commonmeta-py

commonmeta-py is a Python library to implement Commonmeta, the common Metadata Model for Scholarly Metadata. Use commonmeta-py to convert scholarly metadata, in a variety of formats, listed below. Commonmeta-py is work in progress, the first release on PyPi (version 0.5.0) was on February 16, 2023. Up until version 0.5.1, the library was called talbot. Commonmeta-py is modelled after the commonmeta-ruby ruby gem.

commonmeta-py uses semantic versioning. Currently, its major version number is still at 0, meaning the API is not yet stable, and breaking changes are expected in the internal API and commonmeta JSON format.

Installation

Stable version

uv add commonmeta-py

Supported Metadata Formats

Commometa-py reads and/or writes these metadata formats:

Format	Name	Content Type	Read	Write
Commonmeta	commonmeta	application/vnd.commonmeta+json	yes	yes
CrossRef XML	crossref_xml	application/vnd.crossref.unixref+xml	yes	yes
Crossref	crossref	application/vnd.crossref+json	yes	n/a
DataCite	datacite	application/vnd.datacite.datacite+json	yes	yes
Schema.org (in JSON-LD)	schema_org	application/vnd.schemaorg.ld+json	yes	yes
RDF XML	rdf_xml	application/rdf+xml	no	later
RDF Turtle	turtle	text/turtle	no	later
CSL-JSON	csl	application/vnd.citationstyles.csl+json	yes	yes
Formatted text citation	citation	text/x-bibliography	n/a	yes
Codemeta	codemeta	application/vnd.codemeta.ld+json	yes	later
Citation File Format (CFF)	cff	application/vnd.cff+yaml	yes	later
JATS	jats	application/vnd.jats+xml	later	later
CSV	csv	text/csv	no	later
BibTex	bibtex	application/x-bibtex	later	yes
RIS	ris	application/x-research-info-systems	yes	yes
InvenioRDM	inveniordm	application/vnd.inveniordm.v1+json	yes	yes
JSON Feed	jsonfeed	application/feed+json	yes	later
OpenAlex	openalex		yes	no

commonmeta: the Commonmeta format is the native format for the library and used internally. Planned: we plan to implement this format for the v1.0 public release. Later: we plan to implement this format in a later release.

Documentation

Documentation (work in progress) for using the library is available at the commonmeta-py Documentation website and includes several interactive Jupyter Notebooks .

This repository includes a Nixpacks configuration to build and serve the Quarto documentation site in the docs/ folder.

• Config file: nixpacks.toml
• Quarto project: docs/_quarto.yml
• Build output: docs/_site

Coolify setup

• App type: Nixpacks
• Repository/branch: this repo, main
• Build: auto-detected via Nixpacks
• Port: Coolify provides PORT. The start command respects ${PORT} and falls back to 3000 for local runs.
• Healthcheck: HTTP path /, interval 10s, timeout 5s, retries 3

Meta

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

License: MIT