Metaschema processor enhancements

toneillbroad commented 1 week ago

Submitter Name

Terry ONeill

Submitter Affiliation

Broad Institute

Project Details

The metaschema processor is core to processing GA4GH schemas and producing documentation for other developers to explore and utilize the schema hierarchy for their schemas of interest.

This is a placeholder to capture the enhancements necessary to make developers productive in the schema space.

Required Skills

Python

ahwagner commented 1 week ago

One potential addition discussed: building Pydantic data classes Out of scope for hackathon.

toneillbroad commented 1 week ago

Internal docs for the current code base. In scope for Hackathon: Liam/Terry

toneillbroad commented 1 week ago

A new notebook for new developers faced with creating a new schema. Potentially fold into cookie cutter project. Out of scope for hackathon.

toneillbroad commented 1 week ago

JSONschema validation - invalid schemas detected while running MSP In scope for hackathon: Kyle

toneillbroad commented 1 week ago

Github action for on a pull request ensures that you can build the docs. Scan the sphinx logs for any errors and stop processing. In scope for hackathon: Kyle

toneillbroad commented 1 week ago

Github action for when you mint a new vrs release, to automatically update the submodules. Perform the schema validation as part of this. Unrelated to MSP. Out of scope for hackathon.

toneillbroad commented 1 week ago

Github action for on pushing to main ensures that that rebuilds all vrs va gks-common Perhaps cookie-cutter project? Push for github actions to github marketplace Out of scope for hackathon.

toneillbroad commented 1 week ago

Experiment with using http references in the json schema imports instead of relative paths based on submodules. In scope for hackathon: Tristan Plan: Update MSP to handle new syntax for github references Test for said references

toneillbroad commented 1 week ago

Alex: property level maturity tags schemas specify maturity, prefix and keys and they should be reflected in the docs In scope for hackathon: Kori PR: https://github.com/ga4gh/gks-metaschema/pull/29

toneillbroad commented 1 week ago

Add source ruff linting to project as github action. In of scope for Hackthon: Liam

korikuzma commented 1 week ago

Finally opened PR for updating readme: https://github.com/ga4gh/gks-metaschema/pull/21

toneillbroad commented 1 week ago

Actions taken:

Fork the repository (Tristan)
Update pyproject.toml w/ references in .requirements (Kyle)
Update source paths for tests and src paths to work out of the box (Liam)
Kyle added ruff github action
Terry Adding type hints/comments : ○ src/ga4gh/gks/metaschema/scripts/y2t.py ○ src/ga4gh/gks/metaschema/scripts/source2splitjs.py
Kyle CI Automatically build, validate json schema and checking for errors
Kori added missing fields Alex requested
Tristan experimenting with idea of using github references in imports (while still supporting submodules for the short term)

korikuzma commented 1 week ago

https://docs.google.com/presentation/d/15H0HrTYFm_y6oeU9ozq1WBPkyVEXIibznYBWHGzfk6w/edit#slide=id.g311dd3dbe45_0_203

ga4gh / gks-portal