Skip to main content

Schemata for DANDI archive project

Project description

DANDI Schema

dandi-schema is a Python library for maintaining and managing DANDI metadata schemata.

Installation

pip install dandischema

Description

Every Dandiset and associated asset has a metadata object that can be retrieved using the DANDI API. This library helps create and validate DANDI schema-compliant metadata for Dandisets and assets. It uses Pydantic to implement all the metadata classes. Schemas are generated on schema modifications and placed into this repository.

dandi-schema also generates JSON schema definitions and an associated context.json file for JSON-LD compliance of the metadata models.

Important files in this repository include:

  • models.py - contains the models
  • metadata.py - contains functions for validating, migrating, and aggregating metadata
  • datacite.py - converts the Dandiset metadata to a Datacite metadata structure

The generated JSON schemas can be used together with VJSF to create a UI for Dandiset metadata modification as used for Dandiset metadata modification on https://dandiarchive.org.

Also Pydantic models are used by DANDI Client/Library to validate metadata while submitting data to the archive, and later by the DANDI Archive itself to ensure that all metadata conforms the model before Dandiset is allowed to be published and gain a DOI. Such DOI generation is done via Datacite service, and dandi-schema library produces Datacite metadata records out of the Pydantic models.

Resources

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

dandischema-0.11.1.tar.gz (74.7 kB view details)

Uploaded Source

Built Distribution

dandischema-0.11.1-py3-none-any.whl (85.3 kB view details)

Uploaded Python 3

File details

Details for the file dandischema-0.11.1.tar.gz.

File metadata

  • Download URL: dandischema-0.11.1.tar.gz
  • Upload date:
  • Size: 74.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for dandischema-0.11.1.tar.gz
Algorithm Hash digest
SHA256 662ca01ec3bd81ca70becc98727b0aadd5b116a40ad257d11216acab0d8dda66
MD5 b8e0499af17b52a241a2f17f93b10240
BLAKE2b-256 83c368b59ef8f7d49904af4aa4ea730364f3eb02b94cceaaadf128048cbd6370

See more details on using hashes here.

File details

Details for the file dandischema-0.11.1-py3-none-any.whl.

File metadata

  • Download URL: dandischema-0.11.1-py3-none-any.whl
  • Upload date:
  • Size: 85.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for dandischema-0.11.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ac80c29a8dad7b4df2e3c7edd5a830fcb31acabe75c78a4b7323097e136d040f
MD5 6005194f29f6bf6f60d5d33254936c43
BLAKE2b-256 a2a6ea4542a2897f8e0438621bc44cd462021c737c84be85e1964f8625ce6509

See more details on using hashes here.

Supported by

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