Skip to main content

A package for accessing and analysing MalariaGEN data.

Project description

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.:

pip install malariagen-data

Documentation

Documentation of classes and methods in the public API are available from the following locations:

Release notes (change log)

See GitHub releases for release notes.

Developer setup

To get setup for development, see this video and the instructions below.

Fork and clone this repo:

git clone git@github.com:[username]/malariagen-data-python.git

Install Python 3.8 (current recommended version for local development), e.g.:

sudo add-apt-repository ppa:deadsnakes/ppa
sudo apt install python3.8 python3.8-venv

Install pipx, e.g.:

python3.8 -m pip install --user pipx
python3.8 -m pipx ensurepath

Install poetry, e.g.:

pipx install poetry==1.4.1 --python=/usr/bin/python3.8

Create development environment:

cd malariagen-data-python
poetry use 3.8
poetry install

Activate development environment:

poetry shell

Install pre-commit and pre-commit hooks:

pipx install pre-commit --python=/usr/bin/python3.8
pre-commit install

Run pre-commit checks (isort, black, blackdoc, flake8, ...) manually:

pre-commit run --all-files

Run tests:

poetry run pytest -v

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.

Project details


Release history Release notifications | RSS feed

This version

8.5.0

Download files

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

Source Distribution

malariagen_data-8.5.0.tar.gz (125.0 kB view details)

Uploaded Source

Built Distribution

malariagen_data-8.5.0-py3-none-any.whl (146.2 kB view details)

Uploaded Python 3

File details

Details for the file malariagen_data-8.5.0.tar.gz.

File metadata

  • Download URL: malariagen_data-8.5.0.tar.gz
  • Upload date:
  • Size: 125.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.10.12 Linux/6.2.0-1018-azure

File hashes

Hashes for malariagen_data-8.5.0.tar.gz
Algorithm Hash digest
SHA256 a30076abb772adef7e8ffc77814b56aa80e19f4ac6f8d56906e03b2e42ae9184
MD5 3f74e0d4b7bbf624e23f7f462a20022e
BLAKE2b-256 f93bb76a911df7ad214913538e316465dfbc65989ad36d29004321d0f4fd1905

See more details on using hashes here.

Provenance

File details

Details for the file malariagen_data-8.5.0-py3-none-any.whl.

File metadata

  • Download URL: malariagen_data-8.5.0-py3-none-any.whl
  • Upload date:
  • Size: 146.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.10.12 Linux/6.2.0-1018-azure

File hashes

Hashes for malariagen_data-8.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ea16ce094c8138703e6ea212abbe16beadcaa9ccd25fd5661a91fa0aa8068e56
MD5 3747aeded5b67c9ff7ee5a8341ff03bf
BLAKE2b-256 7958d97b6dd52137669cbba64459f6f015afaf41a554946971dd023d79d50558

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page