Skip to main content

Python library for interacting with openMINDS metadata schemas

Project description

openMINDS Python library

openMINDS Python is a small library to support the creation and use of openMINDS metadata models and schemas in your Python application, with import and export in JSON-LD format.

Installation

pip install openMINDS

Usage

from datetime import date
from openminds import Collection, IRI
import openminds.latest.core as omcore

# Create an empty metadata collection

collection = Collection()

# Create some metadata

mgm = omcore.Organization(
    full_name="Metro-Goldwyn-Mayer Studios, Inc.",
    short_name="MGM",
    homepage=IRI("https://www.mgm.com")
)

stan = omcore.Person(
    given_name="Stan",
    family_name="Laurel",
    affiliations=omcore.Affiliation(member_of=mgm, start_date=date(1942, 1, 1))
)

ollie = omcore.Person(
    given_name="Oliver",
    family_name="Hardy",
    affiliations=omcore.Affiliation(member_of=mgm, start_date=date(1942, 1, 1))
)

# Add the metadata to the collection

collection.add(stan, ollie, mgm)

# Check the metadata are valid

failures = collection.validate()

# Save the collection in a single JSON-LD file

collection.save("my_collection.jsonld")

# Save each node in the collection to a separate file

collection.save("my_collection", individual_files=True)  # creates files within the 'my_collection' directory

# Load a collection from file
new_collection = Collection()
new_collection.load("my_collection.jsonld")

License

This work is licensed under the MIT License.

Getting help

In case of questions about openMINDS, please contact us at support@openmetadatainitiative.org. If you find a bug in the Python library or would like to suggest an enhancement or new feature, please open a ticket in the openMINDS Python library issue tracker.

If you identify a problem or would like to suggest changes to the openMINDS specification itself, please open a ticket in the openMINDS issue tracker.

Development

Contributions are welcome, please see our contribution guidelines.

This repository has two main branches: pipeline and main. The pipeline contains the code for building the Python package from the openMINDS schemas. The build process is triggered by changes to the schemas, and runs as a GitHub action. The resultant package is copied to the main branch, and at intervals is published on PyPI.

Acknowledgements

EU Logo

This open source software code was developed in part or in whole in the Human Brain Project, funded from the European Union's Horizon 2020 Framework Programme for Research and Innovation under Specific Grant Agreements No. 720270, No. 785907 and No. 945539 (Human Brain Project SGA1, SGA2 and SGA3), and in the EBRAINS-2.0 project, funded from the European Union's Horizon Europe programme under grant agreement 101147319.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openMINDS-0.2.3.tar.gz (1.1 MB view details)

Uploaded Source

Built Distribution

openMINDS-0.2.3-py3-none-any.whl (1.7 MB view details)

Uploaded Python 3

File details

Details for the file openMINDS-0.2.3.tar.gz.

File metadata

  • Download URL: openMINDS-0.2.3.tar.gz
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.6

File hashes

Hashes for openMINDS-0.2.3.tar.gz
Algorithm Hash digest
SHA256 3a0d757860d04e11adcbba5fd538f2a159364d924052189f8803594feeea138d
MD5 bcf1311b065c77ccbdf1ec6f8257f64c
BLAKE2b-256 55ab46152d31f5e4171756d397a400969b441278d39b76b17a3f1329632f0f15

See more details on using hashes here.

File details

Details for the file openMINDS-0.2.3-py3-none-any.whl.

File metadata

  • Download URL: openMINDS-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 1.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.6

File hashes

Hashes for openMINDS-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 4e40e7dbf476c721e1cc2e975748d687b58cd0183666ec99503d962fd672e0ec
MD5 6811c49e2c1701bd5782a6cbfac8d1df
BLAKE2b-256 03c4d94bec0e1da68dfff4cb4c710fa95a0666532a9e47b205af052ce32afd35

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page