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

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.6.0.tar.gz (125.4 kB view details)

Uploaded Source

Built Distribution

malariagen_data-8.6.0-py3-none-any.whl (148.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: malariagen_data-8.6.0.tar.gz
  • Upload date:
  • Size: 125.4 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.6.0.tar.gz
Algorithm Hash digest
SHA256 94437924892a0240c7b6ff3a798700f03dd21d0cce51ed23f716ee106912f3ab
MD5 f4afa5698a01a8ead4d916c36817d679
BLAKE2b-256 a4fb5b4077fd39effdbcd40603e3d9b5afd5b1baeab86763e7521ef7b1263083

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: malariagen_data-8.6.0-py3-none-any.whl
  • Upload date:
  • Size: 148.5 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.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f6a586b08ee52d1bf92f842484b533ed623420f2b2d45b3319024be14f3f742a
MD5 a628806d8bb16a8c68a51cb6a8b729e1
BLAKE2b-256 33461e396ae56b864a7f6cb096667993d4a114005d72334290a065bd4d78c33e

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