The command line and Python client for the GPAS platform
Project description
GPAS CLI
The command line and Python API client for the GPAS mycobacterial platform. Enables secure sample upload with client-side human read removal and retrieval of analytical outputs.
Install
Installing Miniconda
If a conda package manager is already installed, skip to Installing the GPAS CLI, otherwise:
Linux
- In a terminal console, install Miniconda, following instructions and accepting default options:
curl -O https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh bash Miniconda3-latest-Linux-x86_64.sh
MacOS
The GPAS CLI requires an x86_64 conda installation. If your Mac has an Apple processor, you must disable or delete any existing arm64 conda installations before continuing.
- If your Mac has an Apple processor, using Terminal, firstly run:
arch -x86_64 zsh
- Install Miniconda using Terminal, following instructions and accepting default options:
curl -O https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-x86_64.sh bash Miniconda3-latest-MacOSX-x86_64.sh
Installing or updating the GPAS CLI
-
If using a Mac with an Apple processor, using Terminal, firstly run:
arch -x86_64 zsh
-
Perform the installation/upgrade:
conda create --yes -n gpas -c conda-forge -c bioconda hostile conda activate gpas pip install gpas
-
Test:
gpas --version
Usage
Ensure that the conda environment is active:
conda activate gpas
Help
Run gpas --help for an overview of CLI subcommands. For help with a specific subcommand, use e.g. gpas auth --help
Authentication (gpas auth)
The first time you use the CLI, you will need to authenticate by running gpas auth and entering your username and password. This token will be used automatically for subsequent commands.
gpas auth
Enter your username: bede.constantinides@ndm.ox.ac.uk
Enter your password: ***************
Uploading samples (gpas upload)
Performs metadata validation and client-side removal of human reads in each of your samples before uploading sequences to the GPAS platform.
gpas upload tests/data/illumina.csv
This generates a mapping CSV (e.g. a5w2e8.mapping.csv) linking your local sample names with their randomly generated remote identifiers (GUIDs). Keep this file safe as it's useful for downloading and relinking results later.
Downloading files (gpas download)
Downloads the output (and/or input) files associated with a batch of samples given a mapping CSV generated during upload, or one or more sample GUIDs. When a mapping CSV is used, by default downloaded file names are prefixed with the sample names provided at upload. Otherwise downloaded files are prefixed with the sample GUID.
# Download the main reports for all samples in a5w2e8.mapping.csv
gpas download a5w2e8.mapping.csv
# Download the main and speciation reports for samples in a5w2e8.mapping.csv
gpas download a5w2e8.mapping.csv --filenames main_report.json,speciation_report.json
# Download the main report for one sample
gpas download 3bf7d6f9-c883-4273-adc0-93bb96a499f6
# Download the main report for two samples
gpas download 3bf7d6f9-c883-4273-adc0-93bb96a499f6,6f004868-096b-4587-9d50-b13e09d01882
# Save downloaded files to a specific directory
gpas download a5w2e8.mapping.csv --out-dir results
# Download input files
gpas download --inputs a5w2e8.mapping.csv --filenames ""
Querying sample metadata (gpas query)
Fetches either the processing status (gpas query status) or raw metadata (gpas query raw) of one more samples given a mapping CSV generated during upload, or one or more sample GUIDs.
# Query the processing status of all samples in a5w2e8.mapping.csv
gpas query status a5w2e8.mapping.csv
# Query the processing status of a single sample
gpas query status 3bf7d6f9-c883-4273-adc0-93bb96a499f6
# Query all available metadata in JSON format
gpas query raw a5w2e8.mapping.csv
Support
For technical support, please open an issue or contact support@gpas.global
Development
Development install
git clone https://github.com/GlobalPathogenAnalysisService/cli.git
cd cli
conda env create -y -f environment.yml
pip install --editable '.[dev]'
Updating
git pull origin main
gpas --version
Using an alternate host
-
The stateless way (use
--hostwith every command):gpas auth --host dev.portal.gpas.world gpas download --host dev.portal.gpas.world 516c482d-b92d-4726-99ca-2413f41e41e2 # e.g.
-
The stateful way (no need to use
--hostwith each command):export GPAS_HOST="dev.portal.gpas.world"
Then, as usual:
gpas auth gpas download 516c482d-b92d-4726-99ca-2413f41e41e2 # e.g.
To reset:
unset GPAS_HOST
Using a local development server
export GPAS_HOST="localhost:8000"
export GPAS_PROTOCOL="http"
To unset:
unset GPAS_HOST
unset GPAS_PROTOCOL
Releasing a new version
pytest
# Increment version string inside src/gpas/__init__.py
git tag 0.xx.0 # Tag new version
git push origin main --tags # Push including tags
flit build
flit publish # Uploads to PyPI given appropriate permission
# Announce in Slack CLI channel
# PR gpas/gpas/settings.py with new version
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
Built Distribution
File details
Details for the file gpas-0.23.0.tar.gz.
File metadata
- Download URL: gpas-0.23.0.tar.gz
- Upload date:
- Size: 19.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.31.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7c198656e2824c7f6e565fdcd49057925eb8f61c530c2d31831257c6552bbed7 |
|
| MD5 | fe88a28cac2d4c22c0ed3acf84483d29 |
|
| BLAKE2b-256 | 980d387381ef6952c653cd4bc7c2a874963eb7039c781914a8b9b68b80735b52 |
File details
Details for the file gpas-0.23.0-py3-none-any.whl.
File metadata
- Download URL: gpas-0.23.0-py3-none-any.whl
- Upload date:
- Size: 15.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.31.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f01c8dfb5495118dedb8982528108d69b47ab60148b96323772ee9b307dd6234 |
|
| MD5 | 32d20bc2b3620fe0ed26012278599a8e |
|
| BLAKE2b-256 | 2088e3f8a8ff6fdd3618ae9b35d23635f56070f495b653db3d9cd1f76b68d77c |
