Skip to main content

Python library for interacting with openMINDS metadata schemas

Project description

openMINDS Python

openMINDS Python is a small library that allows you the dynamic usage of openMINDS metadata models and schemas in your Python application for generating your own collection of openMINDS conform metadata representations (instances) as JSON-LDs.

Please note that openMINDS Python only helps you to generate correctly formatted JSON-LD metadata instances - the preparation on how you want to describe your research product with openMINDS is still up to you. If you need support in designing your own openMINDS metadata collection, check out the openMINDS Collab Tutorials which might give you hints on how to tackle your individual case or, of course, get in touch with us directly via our support-email (openminds@ebrains.eu).

Installation

The official versions are available at the Python Package Index and can be installed using pip install in your console:

pip install openMINDS

The latest unstable version is available on this GitHub.

Usage

As stated above, the openMINDS Python allows you the dynamic usage of openMINDS metadata models and schemas in your Python application for generating your own collection of openMINDS conform metadata representations (instances) as JSON-LDs. Here a small example:

import openMINDS
import openMINDS.version_manager

# Initialise the local copy of openMINDS
openMINDS.version_manager.init()

# Select which version of openMINDS to use
openMINDS.version_manager.version_selection('v2.0.0')

# initiate the helper class for the dynamic usage of a specific openMINDS version
helper = openMINDS.Helper()

# initiate the collection into which you will store all metadata instances
mycollection = helper.create_collection()

# create a metadata instance for (e.g.) the openMINDS Person schema
person_open = mycollection.add_core_person(givenName="open")

# add more metadata to a created instance
mycollection.get(person_open).familyName = "MINDS"

# add connections to other metadata instances
email_openminds = mycollection.add_core_contactInformation(email="openminds@ebrains.eu")
mycollection.get(person_open).contactInformation = email_openminds

# save your collection
mycollection.save("./myFirstOpenMINDSMetadataCollection/")

# Getting help for properties
mycollection.help_core_actors_person()

This example generates two linked JSON-LDs, one conform with the openMINDS (v3) Person schema and the other conform with the openMINDS (v3) ContactInformation schema.

To learn in general about the available openMINDS metadata models, schemas and their required or optional metadata properties, check out the openMINDS HTML views which are deployed as GitHub pages on the main openMINDS repository. You can also have a look at the full openMINDS documentation on the EBRAINS Collaboratory.

Within the openMINDS Python you can also get an overview of the requirements of a schema and all its properties by using the 'help_X' function. Here an example:

mycollection.help_core_person()

License

This work is licensed under the MIT License.

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.0.10.tar.gz (11.4 kB view details)

Uploaded Source

Built Distribution

openMINDS-0.0.10-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: openMINDS-0.0.10.tar.gz
  • Upload date:
  • Size: 11.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.9

File hashes

Hashes for openMINDS-0.0.10.tar.gz
Algorithm Hash digest
SHA256 77156ac205553791a851a68cd9baa432a21493e7b88649e4a55cb3b48babad26
MD5 647bd364b4f2ce726d2ae1a6887f315c
BLAKE2b-256 ae8f201bd602148d5c472bced4d5b0308c6eeca8a9a3bbd095bad763329256fd

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: openMINDS-0.0.10-py3-none-any.whl
  • Upload date:
  • Size: 10.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.9

File hashes

Hashes for openMINDS-0.0.10-py3-none-any.whl
Algorithm Hash digest
SHA256 929748a985b3cc7c7eca0b7f71a0985697471ccfb4faf29497c7a0d1b975b2d8
MD5 c4fc5814b32e0eaea3bf200239b0328d
BLAKE2b-256 a241986504581586851696b9108a658a15118f2a46fc91d9f884c44051785770

See more details on using hashes here.

Provenance

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