openminds

Python package for the openMINDS metadata models. The package contains all openMINDS schemas as Python classes in addition to schema base classes and utility methods.

https://github.com/openmetadatainitiative/openminds_python

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (17.2%) to scientific vocabulary

Keywords

openminds programming-package target tooling
Last synced: 4 months ago · JSON representation

Repository

Python package for the openMINDS metadata models. The package contains all openMINDS schemas as Python classes in addition to schema base classes and utility methods.

Basic Info
  • Host: GitHub
  • Owner: openMetadataInitiative
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 5.43 MB
Statistics
  • Stars: 1
  • Watchers: 7
  • Forks: 2
  • Open Issues: 17
  • Releases: 3
Topics
openminds programming-package target tooling
Created over 2 years ago · Last pushed 4 months ago
Metadata Files
Readme License Codemeta

README.md

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

``` python 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( fullname="Metro-Goldwyn-Mayer Studios, Inc.", shortname="MGM", homepage=IRI("https://www.mgm.com") )

stan = omcore.Person( givenname="Stan", familyname="Laurel", affiliations=omcore.Affiliation(memberof=mgm, startdate=date(1942, 1, 1)) )

ollie = omcore.Person( givenname="Oliver", familyname="Hardy", affiliations=omcore.Affiliation(memberof=mgm, startdate=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("mycollection", individualfiles=True) # creates files within the 'my_collection' directory

Load a collection from file

newcollection = Collection() newcollection.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.

Owner

  • Name: openMetadataInitiative
  • Login: openMetadataInitiative
  • Kind: organization

CodeMeta (codemeta.json)

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "license": "https://spdx.org/licenses/Apache-2.0",
  "codeRepository": "https://github.com/openMetadataInitiative/openMINDS_Python",
  "contIntegration": "https://github.com/openMetadataInitiative/openMINDS_Python/actions",
  "issueTracker": "https://github.com/openMetadataInitiative/openMINDS_Python/issues",
  "name": "openMINDS Python",
  "description": "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. The package contains all openMINDS schemas as Python classes in addition to schema base classes and utility methods.",
  "applicationCategory": "neuroscience",
  "releaseNotes": "https://github.com/openMetadataInitiative/openMINDS_Python/blob/pipeline/CHANGELOG.md",
  "funding": "https://cordis.europa.eu/project/id/945539",
  "developmentStatus": "active",
  "funder": {
    "@type": "Organization",
    "name": "European Commission"
  },
  "programmingLanguage": [
    "Python"
  ],
  "operatingSystem": [
    "Linux",
    "Windows",
    "macOS"
  ],
  "softwareRequirements": [
    "Python (version >=3.9)"
  ],
  "relatedLink": [
    "https://openminds-documentation.readthedocs.io"
  ],
  "author": [
    {
      "@type": "Person",
      "@id": "http://orcid.org/0000-0002-4793-7541",
      "givenName": "Andrew P.",
      "familyName": "Davison"
    },
    {
      "@type": "Person",
      "@id": "https://orcid.org/0000-0002-5947-9939",
      "givenName": "Lyuba",
      "familyName": "Zehl"
    },
    {
      "@type": "Person",
      "@id": "https://orcid.org/0000-0003-1746-3995",
      "givenName": "Peyman",
      "familyName": "Najafi"
    },
    {
      "@type": "Person",
      "givenName": "Louisa",
      "familyName": "Köhnen"
    },
    {
      "@type": "Person",
      "@id": "https://orcid.org/0000-0002-5618-9776",
      "givenName": "Raphaël",
      "familyName": "Gazzotti"
    }
  ],
  "version": "0.3.1",
  "downloadUrl": "https://files.pythonhosted.org/packages/d5/b7/b828bc99bb56c4d8c97d587c2e862fa09b81099f538206e642e165352997/openminds-0.3.1.tar.gz",
  "dateModified": "2025-09-09"
}

GitHub Events

Total
  • Issues event: 5
  • Delete event: 3
  • Issue comment event: 5
  • Push event: 70
  • Pull request review event: 14
  • Pull request review comment event: 10
  • Pull request event: 14
  • Fork event: 1
  • Create event: 5
Last Year
  • Issues event: 5
  • Delete event: 3
  • Issue comment event: 5
  • Push event: 70
  • Pull request review event: 14
  • Pull request review comment event: 10
  • Pull request event: 14
  • Fork event: 1
  • Create event: 5

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 3
  • Total pull requests: 8
  • Average time to close issues: 25 days
  • Average time to close pull requests: 19 days
  • Total issue authors: 2
  • Total pull request authors: 3
  • Average comments per issue: 0.33
  • Average comments per pull request: 0.0
  • Merged pull requests: 7
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 3
  • Pull requests: 8
  • Average time to close issues: 25 days
  • Average time to close pull requests: 19 days
  • Issue authors: 2
  • Pull request authors: 3
  • Average comments per issue: 0.33
  • Average comments per pull request: 0.0
  • Merged pull requests: 7
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • apdavison (3)
  • ehennestad (2)
  • Peyman-N (1)
Pull Request Authors
  • apdavison (6)
  • Peyman-N (5)
  • Raphael-Gazzotti (2)
Top Labels
Issue Labels
bug (1)
Pull Request Labels
documentation (2) bug (1) enhancement (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 178 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 18
  • Total maintainers: 5
pypi.org: openminds

Python library for interacting with openMINDS metadata schemas

  • Versions: 18
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 178 Last month
Rankings
Dependent packages count: 10.1%
Downloads: 16.5%
Dependent repos count: 21.6%
Average: 21.9%
Forks count: 22.7%
Stargazers count: 38.8%
Last synced: 4 months ago