submission-schema

The NMDC submission schema.

Note that the while this repo is named submission-schema, the generated artifacts are named nmdc_submission_schema for disambiguation purposes when publishing to PyPI.

Website

Repository Structure

Developer Documentation

Updating the submission schema

The version of nmdc-schema used as a basis when building the submission schema is controlled by a dependency in the dev group, specified in pyproject.toml. You can update the version used by running:

uv add --group dev "nmdc-schema==X.Y.Z"  # replace X.Y.Z with the desired version

[!NOTE]
It is important to use the == version constraint to ensure the exact version is installed.

Building the submission schema

Here's how you can generate the submission schema release artifacts:

Container-based process

Prerequisites
  • Docker is installed on your computer
  • You are in the root directory of the repository
Procedure
  1. Build the container image you will later use to build the submission schema: 
    docker build -t submission-schema-builder -f builder.Dockerfile .
  2. If you haven't already done so (see the "Updating the submission schema" section above), use that container image to update the nmdc-schema dependency of the submission schema: 
    docker run --rm -it -v ${PWD}:/submission-schema submission-schema-builder \
    uv add --group dev "nmdc-schema==X.Y.Z"  # replace X.Y.Z
    Then, rebuild the container image (so it has that new version of nmdc-schema installed): 
    docker build -t submission-schema-builder -f builder.Dockerfile .
  3. Use the container image to build the submission schema: 
    docker run --rm -it -v ${PWD}:/submission-schema submission-schema-builder
  4. Commit the changes, using the new nmdc-schema version number as the commit message; like this: 
    git add .
git commit -m "X.Y.Z"  # replace X.Y.Z with the nmdc-schema version
  5. (Optional) Delete the container image: 
    docker image rm submission-schema-builder

Direct process

Procedure
  1. Install Python dependencies: 
    uv sync
  2. Generate the release artifacts: 
    make clean all
  3. Commit the changes, using the new nmdc-schema version number as the commit message; like this: 
    git add .
git commit -m "X.Y.Z"  # replace X.Y.Z with the nmdc-schema version

Credits

this project was made with linkml-project-cookiecutter

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

Owner

PyPI data
Data sourced directly from PyPI's database.

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for mamillerpa from gravatar.com mamillerpa

Credits

Author: Mark Andrew Miller

License expression

MIT
View SPDX License List

Requires

Python <4, >=3.10

Report project as malware

Download files

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

Source Distribution

nmdc_submission_schema-11.22.0.tar.gz (738.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nmdc_submission_schema-11.22.0-py3-none-any.whl (754.2 kB view details)

Uploaded Python 3

File details

Details for the file nmdc_submission_schema-11.22.0.tar.gz.

File metadata

  • Download URL: nmdc_submission_schema-11.22.0.tar.gz
  • Upload date:
  • Size: 738.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for nmdc_submission_schema-11.22.0.tar.gz
Algorithm Hash digest
SHA256 456ec54ac721d081d9f008d21a4bd33c4ccf569e8185279c83e9e5506e0a69a4
MD5 a717f7998f4a4755ab248f560ad52086
BLAKE2b-256 a423a976b7033d62e74baa841e12ba1fe55e1ef602703e9664bf90f836eecfcf

See more details on using hashes here.

Provenance

The following attestation bundles were made for nmdc_submission_schema-11.22.0.tar.gz:

Publisher: pypi-publish.yaml on microbiomedata/submission-schema

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file nmdc_submission_schema-11.22.0-py3-none-any.whl.

File metadata

File hashes

Hashes for nmdc_submission_schema-11.22.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5b8719d4af2dfb0325f153e598c24860a0ef40610d01959f55ece5f49c4b3a48
MD5 56c68d2c5c157dd63b6dd29d02009526
BLAKE2b-256 cb1586881c00d284ad48f2ad5cef5fd855b3b0bcd4160c26c22979398ec1c662

See more details on using hashes here.

Provenance

The following attestation bundles were made for nmdc_submission_schema-11.22.0-py3-none-any.whl:

Publisher: pypi-publish.yaml on microbiomedata/submission-schema

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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