fairscape_models
Pydantic models that define the canonical data shape for Fairscape RO-Crate releases. This package is the source of truth: the JSON Schemas, TypeScript types, and the EVI OWL/RDFS vocabulary published with the Fairscape profile are all generated from the classes in fairscape_models/.
What's in here
| Path | What it is |
|---|---|
fairscape_models/*.py |
Pydantic class definitions: Dataset, Software, MLModel, Computation, Annotation, Experiment, Schema, Sample, Instrument, Patient, ModelCard, AnnotatedComputation, AnnotatedEvidenceGraph, ROCrateMetadataElem, ROCrateV1_2, … |
fairscape_models/conversion/ |
Crosswalks: Datasheet-for-Datasets (LinkML), Croissant / Croissant-RAI 1.0. |
json-schemas/ |
Per-class JSON Schemas, generated by scripts/generate_json_schemas.py. |
typescript-types/ |
TypeScript .d.ts declarations, generated by scripts/generate_ts_types.py. |
js/ |
JavaScript bindings. |
profiles/evi-vocabulary.ttl |
OWL/RDFS vocabulary for the EVI namespace, generated by scripts/generate_profile.py. Contains the class hierarchy, property domains/ranges, and owl:Restriction cardinality blocks. |
profiles/profile.ttl |
W3C PROF manifest for the Fairscape profile (see below). |
tests/ |
pytest suite. Test fixtures under tests/test_rocrates/ are real conforming crates. |
Profile
This package implements the Fairscape Release RO-Crate Profile v0.1:
- Profile URI: https://w3id.org/fairscape/profile/0.1
- Specification: https://fairscape.github.io/profile/0.1/
- PROF manifest:
profiles/profile.ttl - EVI vocabulary:
profiles/evi-vocabulary.ttl
Every crate produced from the ROCrateMetadataElem model declares dct:conformsTo: https://w3id.org/fairscape/profile/0.1 on its Root Data Entity. This is the conformance signal — the Root entity's @type stays ["Dataset", "https://w3id.org/EVI#ROCrate"] and never includes "Profile". (Only the hand-authored Profile Crate published at the profile URI is Profile-typed.)
Regenerating derived artifacts
python scripts/generate_json_schemas.py
python scripts/generate_ts_types.py
python scripts/generate_profile.py profiles/evi-vocabulary.ttl
Tests
pytest
Release files for fairscape-models 1.2.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| fairscape_models-1.2.3.tar.gz | 814.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| fairscape_models-1.2.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 964.8 kB
Release files / fairscape_models-1.2.3.tar.gz
| Download URL | fairscape_models-1.2.3.tar.gz |
|---|---|
| Size | 814.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e4f07eb44b88e46962a3f7f8513c9ba5aadc63461f73da134148c4fce4335a2a
|
|
BLAKE2b-256 checksum How to use checksums |
e97f07f2fa1245b61f8219c82be152f5df00fca66184ac4353a1d8654f0820de
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.3
|
Release files / fairscape_models-1.2.3-py3-none-any.whl
| Download URL | fairscape_models-1.2.3-py3-none-any.whl |
|---|---|
| Size | 150.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c7328bfd3c177a227c2e10b6de96d7b67e4cdca6dfc3f09fb1c41f6c33e4c814
|
|
BLAKE2b-256 checksum How to use checksums |
79c0d63db2232e8c643f0218f401e6c6a8bdd07104bf4f12bb7fe0e1f13ff730
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.3
|
