Metadata-Version: 2.4
Name: gpmappy
Version: 0.1.1
Summary: Python client for the OpenGWAS genotype-phenotype map API
Project-URL: Homepage, https://github.com/MRCIEU/gpmappy
Project-URL: Repository, https://github.com/MRCIEU/gpmappy
Project-URL: Issues, https://github.com/MRCIEU/gpmappy/issues
Project-URL: Documentation, https://MRCIEU.github.io/gpmappy/
Project-URL: Changelog, https://github.com/MRCIEU/gpmappy/blob/main/CHANGELOG.md
Author: gpt-5.3-codex, t0mrg, andrew-e, explodecomputer
License: MIT
License-File: LICENSE
Keywords: api,bioinformatics,genetics,gwas,opengwas
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: Typing :: Typed
Requires-Python: >=3.9
Requires-Dist: httpx<1.0,>=0.24
Requires-Dist: typing-extensions>=4.9.0; python_version < '3.11'
Provides-Extra: bench
Requires-Dist: pandas<3.0,>=1.5; extra == 'bench'
Requires-Dist: pytest-benchmark>=4.0.0; extra == 'bench'
Provides-Extra: dataframe
Requires-Dist: pandas<3.0,>=1.5; extra == 'dataframe'
Provides-Extra: dev
Requires-Dist: black>=23.0.0; extra == 'dev'
Requires-Dist: build>=1.0.0; extra == 'dev'
Requires-Dist: mypy>=1.5.0; extra == 'dev'
Requires-Dist: pandas<3.0,>=1.5; extra == 'dev'
Requires-Dist: pre-commit>=3.7.0; extra == 'dev'
Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
Requires-Dist: pytest-mock>=3.10.0; extra == 'dev'
Requires-Dist: pytest>=7.2.0; extra == 'dev'
Requires-Dist: respx>=0.20.0; extra == 'dev'
Requires-Dist: ruff>=0.1.0; extra == 'dev'
Requires-Dist: twine>=4.0.0; extra == 'dev'
Requires-Dist: vcrpy>=5.1.0; extra == 'dev'
Provides-Extra: docs
Requires-Dist: mkdocs-material>=9.0.0; extra == 'docs'
Requires-Dist: mkdocs>=1.4.0; extra == 'docs'
Requires-Dist: mkdocstrings[python]>=0.23.0; extra == 'docs'
Description-Content-Type: text/markdown

# gpmappy

Python client for the OpenGWAS genotype-phenotype map API.

## Install

Base install:

```bash
pip install gpmappy
```

Install with DataFrame support:

```bash
pip install "gpmappy[dataframe]"
```

## Quick start

```python
from gpmappy import GpmapClient

client = GpmapClient()

health = client.health_api()
print(health)

results = client.search_gpmap("haemoglobin")
print(results.head() if hasattr(results, "head") else results[:5])
```

## Output behavior

- Table-like outputs return pandas DataFrames when pandas is installed.
- Without pandas, table-like outputs return `list[dict]`.
- Use `as_dataframe=True` to require DataFrame output, or `as_dataframe=False` to force list output.

## Resources

- Documentation: https://MRCIEU.github.io/gpmappy/
- Source: https://github.com/MRCIEU/gpmappy
- Issues: https://github.com/MRCIEU/gpmappy/issues
