# `malariagen_data` - analyse MalariaGEN data from Python
This Python package provides methods for accessing and analysing data from MalariaGEN.
## Installation
The `malariagen_data` Python package is available from the Python
package index (PyPI) and can be installed via `pip`, e.g.:
```bash
pip install malariagen-data
```
## Documentation
Documentation of classes and methods in the public API are available
from the following locations:
- [Ag3 API
docs](https://malariagen.github.io/malariagen-data-python/latest/Ag3.html)
- [Amin1 API
docs](https://malariagen.github.io/malariagen-data-python/latest/Amin1.html)
- [Pf7 API
docs](https://malariagen.github.io/parasite-data/pf7/api.html)
- [Pv4 API
docs](https://malariagen.github.io/parasite-data/pv4/api.html)
## Release notes (change log)
See [GitHub releases](https://github.com/malariagen/malariagen-data-python/releases)
for release notes.
## Developer setup
To get setup for development, see [this
video](https://youtu.be/QniQi-Hoo9A) and the instructions below.
Fork and clone this repo:
```bash
git clone git@github.com:[username]/malariagen-data-python.git
```
Install Python, e.g.:
```bash
sudo add-apt-repository ppa:deadsnakes/ppa
sudo apt install python3.9 python3.9-venv
```
Install pipx, e.g.:
```bash
python3.9 -m pip install --user pipx
python3.9 -m pipx ensurepath
```
Install [poetry](https://python-poetry.org/docs/#installation), e.g.:
```bash
pipx install poetry==1.8.2 --python=/usr/bin/python3.9
```
Create development environment:
```bash
cd malariagen-data-python
poetry use 3.9
poetry install
```
Activate development environment:
```bash
poetry shell
```
Install pre-commit and pre-commit hooks:
```bash
pipx install pre-commit --python=/usr/bin/python3.9
pre-commit install
```
Run pre-commit checks (isort, black, blackdoc, flake8, ...) manually:
```bash
pre-commit run --all-files
```
Run fast unit tests using simulated data:
```bash
poetry run pytest -v tests/anoph
```
To run legacy tests which read data from GCS, you'll need to [install the Google Cloud CLI](https://cloud.google.com/sdk/docs/install). E.g., if on Linux:
```bash
./install_gcloud.sh
```
You'll then need to obtain application-default credentials, e.g.:
```bash
./google-cloud-sdk/bin/gcloud auth application-default login
```
Once this is done, you can run legacy tests:
```bash
poetry run pytest --ignore=tests/anoph -v tests
```
Tests will run slowly the first time, as data required for testing
will be read from GCS. Subsequent runs will be faster as data will be
cached locally in the "gcs_cache" folder.
## Release process
Create a new GitHub release. That's it. This will automatically
trigger publishing of a new release to PyPI and a new version of
the documentation via GitHub Actions.
The version switcher for the documentation can then be updated by
modifying the `docs/source/_static/switcher.json` file accordingly.
Raw data
{
"_id": null,
"home_page": "https://github.com/malariagen/malariagen-data-python",
"name": "malariagen_data",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Alistair Miles",
"author_email": "alistair.miles@sanger.ac.uk",
"download_url": "https://files.pythonhosted.org/packages/f3/1b/39dfa8b8d267cc6e5c4082464608e17533b82dc94ea96e5abf6e0a1436d6/malariagen_data-11.0.0.tar.gz",
"platform": null,
"description": "# `malariagen_data` - analyse MalariaGEN data from Python\n\nThis Python package provides methods for accessing and analysing data from MalariaGEN.\n\n## Installation\n\nThe `malariagen_data` Python package is available from the Python\npackage index (PyPI) and can be installed via `pip`, e.g.:\n\n```bash\npip install malariagen-data\n```\n\n## Documentation\n\nDocumentation of classes and methods in the public API are available\nfrom the following locations:\n\n- [Ag3 API\n docs](https://malariagen.github.io/malariagen-data-python/latest/Ag3.html)\n\n- [Amin1 API\n docs](https://malariagen.github.io/malariagen-data-python/latest/Amin1.html)\n\n- [Pf7 API\n docs](https://malariagen.github.io/parasite-data/pf7/api.html)\n\n- [Pv4 API\n docs](https://malariagen.github.io/parasite-data/pv4/api.html)\n\n## Release notes (change log)\n\nSee [GitHub releases](https://github.com/malariagen/malariagen-data-python/releases)\nfor release notes.\n\n## Developer setup\n\nTo get setup for development, see [this\nvideo](https://youtu.be/QniQi-Hoo9A) and the instructions below.\n\nFork and clone this repo:\n\n```bash\ngit clone git@github.com:[username]/malariagen-data-python.git\n```\n\nInstall Python, e.g.:\n\n```bash\nsudo add-apt-repository ppa:deadsnakes/ppa\nsudo apt install python3.9 python3.9-venv\n```\n\nInstall pipx, e.g.:\n\n```bash\npython3.9 -m pip install --user pipx\npython3.9 -m pipx ensurepath\n```\n\nInstall [poetry](https://python-poetry.org/docs/#installation), e.g.:\n\n```bash\npipx install poetry==1.8.2 --python=/usr/bin/python3.9\n```\n\nCreate development environment:\n\n```bash\ncd malariagen-data-python\npoetry use 3.9\npoetry install\n```\n\nActivate development environment:\n\n```bash\npoetry shell\n```\n\nInstall pre-commit and pre-commit hooks:\n\n```bash\npipx install pre-commit --python=/usr/bin/python3.9\npre-commit install\n```\n\nRun pre-commit checks (isort, black, blackdoc, flake8, ...) manually:\n\n```bash\npre-commit run --all-files\n```\n\nRun fast unit tests using simulated data:\n\n```bash\npoetry run pytest -v tests/anoph\n```\n\nTo run legacy tests which read data from GCS, you'll need to [install the Google Cloud CLI](https://cloud.google.com/sdk/docs/install). E.g., if on Linux:\n\n```bash\n./install_gcloud.sh\n```\n\nYou'll then need to obtain application-default credentials, e.g.:\n\n```bash\n./google-cloud-sdk/bin/gcloud auth application-default login\n```\n\nOnce this is done, you can run legacy tests:\n\n```bash\npoetry run pytest --ignore=tests/anoph -v tests\n```\n\nTests will run slowly the first time, as data required for testing\nwill be read from GCS. Subsequent runs will be faster as data will be\ncached locally in the \"gcs_cache\" folder.\n\n## Release process\n\nCreate a new GitHub release. That's it. This will automatically\ntrigger publishing of a new release to PyPI and a new version of\nthe documentation via GitHub Actions.\n\nThe version switcher for the documentation can then be updated by\nmodifying the `docs/source/_static/switcher.json` file accordingly.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A package for accessing and analysing MalariaGEN data.",
"version": "11.0.0",
"project_urls": {
"Documentation": "https://malariagen.github.io/malariagen-data-python/latest/",
"Homepage": "https://github.com/malariagen/malariagen-data-python",
"Repository": "https://github.com/malariagen/malariagen-data-python"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2ae39b5b7f54a335d6ef09b6e135cce2d24a2d570f2ebd8fd5be95225edfba62",
"md5": "71a9702c2bce47d46c3e2a2e56bf9e01",
"sha256": "8a4a358a41582c3e0ad2023faf588ed44c72f477de63f5388c0bf81bf6af263b"
},
"downloads": -1,
"filename": "malariagen_data-11.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "71a9702c2bce47d46c3e2a2e56bf9e01",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.9",
"size": 165080,
"upload_time": "2024-06-21T13:10:33",
"upload_time_iso_8601": "2024-06-21T13:10:33.692230Z",
"url": "https://files.pythonhosted.org/packages/2a/e3/9b5b7f54a335d6ef09b6e135cce2d24a2d570f2ebd8fd5be95225edfba62/malariagen_data-11.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f31b39dfa8b8d267cc6e5c4082464608e17533b82dc94ea96e5abf6e0a1436d6",
"md5": "3de192624137b071ac1576f597dae1a3",
"sha256": "16f7e96a1af852627056444dfe85bc25af1d34ae14bebc0aa368b229dc3fb345"
},
"downloads": -1,
"filename": "malariagen_data-11.0.0.tar.gz",
"has_sig": false,
"md5_digest": "3de192624137b071ac1576f597dae1a3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.9",
"size": 137636,
"upload_time": "2024-06-21T13:10:36",
"upload_time_iso_8601": "2024-06-21T13:10:36.493825Z",
"url": "https://files.pythonhosted.org/packages/f3/1b/39dfa8b8d267cc6e5c4082464608e17533b82dc94ea96e5abf6e0a1436d6/malariagen_data-11.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-21 13:10:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "malariagen",
"github_project": "malariagen-data-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "malariagen_data"
}
JSON
