GA4GH Genomic Knowledge Standards meta-schema tools

These details have been verified by PyPI

Project links

GitHub Statistics

Maintainers

These details have not been verified by PyPI

Project description

gks-metaschema

Tools and scripts for parsing the GA4GH Genomic Knowledge Standards (GKS) metaschemas. The metaschema processor (MSP) converts JSON Schema Version 2020-12 in YAML to reStructuredText (RST) and JSON files.

Currently used in:

Installing for development

Prerequisites

Python 3.12: We recommend using pyenv.

Installation Steps

Fork the repo at https://github.com/ga4gh/gks-metaschema, and initialize a development environment.

git clone git@github.com:YOUR_GITHUB_ID/gks-metaschema.git
cd gks-metaschema
make devready
source venv/3.12/bin/activate

Set up the pre-commit hook

cp ./scripts/pre-commit ./.git/hooks/

Testing

To run the tests:

make test

Usage

File Hierarchy

The metaschema processor expects the following hierarchy:

├── docs
│   ├── source
│   |   ├── ...
│   ├── Makefile
├── schema
│   ├──gks_schema
│   |   ├── gks-schema-source.yaml
│   |   ├── Makefile
│   |   ├── prune.mk
│   ├── Makefile

docs: Sphinx documentation directory. Must be named docs.
- source: Directory containing documentation written in reStructuredText and Sphinx configuration. Must be named source.
- Makefile: Commands to create the reStructuredText files. This file should not change across GKS projects.
schema: Schema directory. Can also contain submodules for other GKS product schemas.
- gks_schema: Schema directory for GKS product. The directory name should reflect the product, e.g. vrs.
  - gks-schema-source.yaml: Source document for the JSON Schema 2020-12. The file name should reflect the standard, e.g. vrs-source.yaml. The file name must end with -source.yaml.
  - Makefile: Commands to create the reStructuredText and JSON files. This file should not change across GKS projects.
  - prune.mk: Cleanup of files in def and json directories based on source document. This file should not change across GKS projects.
- Makefile: Commands to create the reStructuredText and JSON files.

Contributing to the schema

To create the corresponding def (reStructuredText) and json files after making changes to the source document, from the schema directory:

    make all

The file structure will now look like:

├── schema
│   ├──gks_schema
|   |   ├── def
│   |   |   ├── ...
|   |   ├── json
│   |   |   ├── ...
│   |   ├── gks-schema-source.yaml
│   |   ├── Makefile
│   |   ├── prune.mk
│   ├── Makefile

Contributing to the docs

GKS specification documentation is written in reStructuredText and located in docs/source.

To build documentation locally, you must install entr:

brew install entr

Then from the docs directory:

make clean watch &

Then, open docs/build/html/index.html. The above make command should build docs when the source changes.

NOTE: Some types of changes require recleaning and building.

Project details

These details have been verified by PyPI

Project links

GitHub Statistics

Maintainers

alex.phd

These details have not been verified by PyPI

Release history Release notifications | RSS feed

0.3.0b17 pre-release

Nov 8, 2024

0.3.0b16 pre-release

Nov 7, 2024

This version

0.3.0b15 pre-release

Nov 7, 2024

0.3.0b14 pre-release

Oct 23, 2024

0.3.0b13 pre-release

Sep 9, 2024

0.3.0b12 pre-release

Sep 6, 2024

0.3.0b11 pre-release

Aug 13, 2024

0.3.0b10 pre-release

Aug 12, 2024

0.3.0b9 pre-release

Mar 6, 2024

0.3.0b8 pre-release

Mar 6, 2024

0.3.0b7 pre-release

Mar 5, 2024

0.3.0b6 pre-release

Mar 5, 2024

0.3.0b5 pre-release

Mar 4, 2024

0.3.0b4 pre-release

Mar 4, 2024

0.3.0b3 pre-release yanked

Mar 3, 2024

Reason this release was yanked:

fatal bug

0.3.0b2 pre-release

Mar 3, 2024

0.3.0b1 pre-release

Mar 1, 2024

0.2.1

Sep 10, 2023

0.2.0

Sep 9, 2023

0.2.0rc5 pre-release

Jul 8, 2023

0.2.0rc4 pre-release

Oct 7, 2022

0.2.0rc3 pre-release

Aug 17, 2022

0.2.0rc2 pre-release

Aug 16, 2022

0.2.0rc1 pre-release

Aug 4, 2022

0.1.1

Nov 22, 2021

0.1.0

Nov 7, 2021

0.0.0 yanked

Aug 13, 2024

Reason this release was yanked:

Did not mean to release a 0.0.0 version

Download files

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

Source Distribution

ga4gh_gks_metaschema-0.3.0b15.tar.gz (59.2 kB view details)

Uploaded Nov 7, 2024 Source

Built Distribution

ga4gh.gks.metaschema-0.3.0b15-py3-none-any.whl (23.1 kB view details)

Uploaded Nov 7, 2024 Python 3

File details

Details for the file ga4gh_gks_metaschema-0.3.0b15.tar.gz.

File metadata

Download URL: ga4gh_gks_metaschema-0.3.0b15.tar.gz
Upload date: Nov 7, 2024
Size: 59.2 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for ga4gh_gks_metaschema-0.3.0b15.tar.gz
Algorithm	Hash digest
SHA256	`8acc29a8fea20465d42d376973260363a1e5fb103904f6d40b338f81952aaa98`
MD5	`00969d9021e07028990724e5b91fb7de`
BLAKE2b-256	`ca498d6cf91700b219ed89cf00691690ffe81d90ae175cc56f9ae64982af30c2`

See more details on using hashes here.

Provenance

The following attestation bundles were made for ga4gh_gks_metaschema-0.3.0b15.tar.gz:

Publisher: release.yaml on ga4gh/gks-metaschema

Attestations:

Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: ga4gh_gks_metaschema-0.3.0b15.tar.gz
- Subject digest: 8acc29a8fea20465d42d376973260363a1e5fb103904f6d40b338f81952aaa98
- Sigstore transparency entry: 147426604
- Sigstore integration time: Nov 7, 2024