Skip to main content

Python package

Reproschema Python library and Command Line Interface (CLI)

The reproschema-py library provides a Python interface and a command-line tool to work with ReproSchema, a YAML-based framework for creating and managing reproducible research protocols.

For more information, see the full documentation.

Installation

reproschema requires Python 3.10+.

pip install reproschema

Developer Guide

Developer installation

Fork this repo to your own GitHub account, then clone and install your forked repo in the developer mode:

git clone https://github.com/<your github>/reproschema-py.git
cd reproschema-py
pip install -e .

Notes on the reproschema model

This repository uses the pydantic representation of the reproschema model, defined in model.py. The pydantic model is automatically generated from the LinkML model maintained in the ReproNim/reproschema repository. All changes to the model should be made in the LinkML source in that repository.

Style

This repo uses pre-commit to check styling.

  • Install pre-commit with pip: pip install pre-commit
  • In order to use it with the repository, you have to run run pre-commit install in the root directory the first time you use it.

When pre-commit is used, you may have to run git commit twice, since pre-commit may make additional changes to your code for styling and will not commit these changes by default.

Metadata

Release files for reproschema 1.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for reproschema 1.1.0
File Size Uploaded Provenance
reproschema-1.1.0.tar.gz 446.0 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for reproschema 1.1.0
File Interpreter ABI Platform
reproschema-1.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 951.9 kB

Release files / reproschema-1.1.0.tar.gz

Download URL reproschema-1.1.0.tar.gz
Size 446.0 kB
Tags Source
SHA-256 checksum
How to use checksums
45b199c79e0bddadadbcbb7c14a83175673daa696744c66c3aa84dc022ab8f51
BLAKE2b-256 checksum
How to use checksums
7028623283dfd4e74d9e87c2822b9d8d3105a2a5e36145c57dc10a45ef5d8145
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.2

Release files / reproschema-1.1.0-py3-none-any.whl

Download URL reproschema-1.1.0-py3-none-any.whl
Size 505.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4f60796753b0674d706a675edce51f5a8489dcddfabfe100956e87834aaae8f7
BLAKE2b-256 checksum
How to use checksums
2c33470d56b555bd65ed8b0f17d377e111afd68fcb86eb418162ec4cc2868d6b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.2

Security for reproschema 1.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page