Pydantic schema for TissUUmaps
Project description
TissUUmaps-schema
Pydantic schema for TissUUmaps
Requirements
Python 3.9 or later
Installation
Use the package manager pip to install tissuumaps-schema:
pip install tissuumaps-schema
Usage
To list all available $VERSION
values:
tissuumaps-schema versions
To list all available $MODEL
values for the specified $VERSION
:
tissuumaps-schema models --version $VERSION
To generate a JSON Schema for the specified $VERSION
and $MODEL
:
tissuumaps-schema generate --version $VERSION $MODEL
To upgrade an existing instance of $MODEL
to the specified $VERSION
:
tissuumaps-schema upgrade --to-version $VERSION $MODEL myinstance.json
To validate an existing instance of $MODEL
against the specified $VERSION
:
tissuumaps-schema validate --expect-version $VERSION $MODEL myinstance.json
Support
For each $VERSION
and $MODEL
(lower case), a JSON Schema is hosted on:
https://tissuumaps.github.io/TissUUmaps-schema/$VERSION/$MODEL.json
The JSON Schema of each $VERSION
and $MODEL
(lower case) is documented on:
https://tissuumaps.github.io/TissUUmaps-schema/$VERSION/$MODEL.html
If you find a bug, please raise an issue.
Contributing
Pull requests are welcome.
For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
Changelog
Authors
SciLifeLab BioImage Informatics Facility (BIIF)
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
Built Distribution
Hashes for tissuumaps_schema-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b8d10ef28cde56587759c492734a7a271e7fb2f7c62d7c5e10a4902eb9488ff5 |
|
MD5 | 98c24f2c48e34a339577c9de8182760a |
|
BLAKE2b-256 | 79a9d1a58a532286781bb4bb82c7907d07433c5bcad3a0c5a72565f189fe9586 |