Metadata-Version: 2.4
Name: ga4gh.gkm
Version: 0.2.0
Summary: Genomic Knowledge Model toolkit
Author: GKM Contributors
License-Expression: CC0-1.0
Project-URL: Homepage, https://github.com/ga4gh/gkm-starter-kit
Project-URL: Documentation, https://ga4gh.github.io/gkm-starter-kit
Project-URL: Changelog, https://github.com/ga4gh/gkm-starter-kit/releases
Project-URL: Source, https://github.com/ga4gh/gkm-starter-kit
Project-URL: Bug Tracker, https://github.com/ga4gh/gkm-starter-kit/issues
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: ga4gh.va_spec~=0.5.0-a4
Provides-Extra: docs
Requires-Dist: mkdocs==1.6.1; extra == "docs"
Requires-Dist: mkdocs-material==9.5.49; extra == "docs"
Requires-Dist: mkdocs-macros-plugin==1.3.7; extra == "docs"
Requires-Dist: mkdocs-gen-files==0.5.0; extra == "docs"
Requires-Dist: json-schema-for-humans==1.5.1; extra == "docs"
Requires-Dist: PyYAML==6.0.2; extra == "docs"
Requires-Dist: mkdocstrings[python]; extra == "docs"
Provides-Extra: tests
Requires-Dist: pytest; extra == "tests"
Requires-Dist: pytest-cov; extra == "tests"
Provides-Extra: dev
Requires-Dist: prek>=0.2.23; extra == "dev"
Requires-Dist: ruff==0.14.10; extra == "dev"
Provides-Extra: notebooks
Requires-Dist: ipykernel; extra == "notebooks"
Dynamic: license-file

# GKM Starter Kit

A practical entry point for using the GA4GH Genomic Knowledge Model (GKM).

**Live site:** <https://ga4gh.github.io/gkm-starter-kit/>

The Starter Kit brings together three complementary resources:

- **Data Bundles** package related GKM objects from participating producers.
- **`ga4gh.gkm`** provides Python tools for loading and working with those bundles.
- **Vignettes** show how implementers use GKM standards to solve real problems.

Start with the [documentation](https://ga4gh.github.io/gkm-starter-kit/) for an
overview, examples, and API details.

## Contributing a vignette

1. Read the [contribution guide](https://ga4gh.github.io/gkm-starter-kit/contribute/) on the live site.
2. Either:
    - Open a [**Propose a vignette**](https://github.com/ga4gh/gkm-starter-kit/issues/new?template=propose-vignette.yml) issue, or
    - Copy `docs/vignettes/_template/vignette.md` into a new `docs/vignettes/<slug>/` folder, fill it in, and open a PR.

## `ga4gh.gkm` Python package

[![image](https://img.shields.io/pypi/v/ga4gh.gkm.svg)](https://pypi.org/project/ga4gh.gkm/)
[![image](https://img.shields.io/pypi/l/ga4gh.gkm.svg)](https://pypi.org/project/ga4gh.gkm/)
[![image](https://img.shields.io/pypi/pyversions/ga4gh.gkm.svg)](https://pypi.org/project/ga4gh.gkm/)
[![Actions status](https://github.com/ga4gh/gkm-starter-kit/actions/workflows/checks.yaml/badge.svg)](https://github.com/ga4gh/gkm-starter-kit/actions/workflows/checks.yaml)

### Installation

Install from [PyPI](https://pypi.org/project/ga4gh.gkm/):

```shell
python3 -m pip install ga4gh.gkm
```

## Development

Clone the repo and create a virtual environment:

```shell
git clone https://github.com/ga4gh/gkm-starter-kit
cd gkm-starter-kit
python3 -m venv venv
source venv/bin/activate
```

Install development dependencies and `prek`:

```shell
python3 -m pip install -e '.[dev,tests,docs,notebooks]'
prek install
```

Check style with `ruff`:

```shell
python3 -m ruff check .
python3 -m ruff format --check .
```

Run tests with `pytest`:

```shell
pytest
```

## Docs

```shell
mkdocs serve
```

Then open <http://127.0.0.1:8000>.

## License

[CC0 1.0 Universal](LICENSE)
