Skip to main content

Python client for Toolchest

Project description

Toolchest Python Client

Toolchest runs computational biology software in the cloud with just a few lines of code. You can call Toolchest from anywhere Python or R runs, using input files located on your computer or S3.

This package contains the Python client for using Toolchest. For the R client, see here.

Documentation & User Guide

Installation

The Toolchest client is available on PyPI:

pip install toolchest-client

Usage

Using a tool in Toolchest is as simple as:

import toolchest_client as toolchest
toolchest.set_key("YOUR_TOOLCHEST_KEY")
toolchest.kraken2(
  tool_args="",
  inputs="path/to/input.fastq",
  output_path="path/to/output.fastq",
)

For a list of available tools, see the documentation.

Configuration

To use Toolchest, you must have an authentication key stored in the TOOLCHEST_KEY environment variable.

import toolchest_client as toolchest
toolchest.set_key("YOUR_TOOLCHEST_KEY") # or a file path containing the key

Contact Toolchest if:

  • you need a key
  • you’ve forgotten your key
  • the key is producing authentication errors.

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

toolchest_client-0.11.14.tar.gz (61.4 kB view details)

Uploaded Source

Built Distribution

toolchest_client-0.11.14-py3-none-any.whl (85.4 kB view details)

Uploaded Python 3

File details

Details for the file toolchest_client-0.11.14.tar.gz.

File metadata

  • Download URL: toolchest_client-0.11.14.tar.gz
  • Upload date:
  • Size: 61.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.1 CPython/3.8.16 Linux/5.15.0-1030-aws

File hashes

Hashes for toolchest_client-0.11.14.tar.gz
Algorithm Hash digest
SHA256 ca081e36a176688c042a9d2b6d0ef51b71a87456b65d8bb22bea6df57f73c484
MD5 7554fdae163753328e2a92645bf99452
BLAKE2b-256 7886c0c8f742b1af521f35a07feefd7845c82c22f1a7fe785918d7208d2a3d2d

See more details on using hashes here.

File details

Details for the file toolchest_client-0.11.14-py3-none-any.whl.

File metadata

File hashes

Hashes for toolchest_client-0.11.14-py3-none-any.whl
Algorithm Hash digest
SHA256 eb73b46fcd8376232eea22c4d23f107fcb5c4faff3dac09dd9a44da470e91677
MD5 08ddccfc9ea9d752e3c45bc8c21a54b0
BLAKE2b-256 599b5fe2df763208fe8cd65d40c9ae1678b5c1c919da616f2b34aca4127650e2

See more details on using hashes here.

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