Skip to main content

A library to rapidly fetch fetch MLST profiles given sequences for various diseases.

Project description

autoBIGS.Engine

A python library implementing common BIGSdb MLST schemes and databases. Implementation follows the RESTful API outlined by the official BIGSdb documentation up to V1.50.0.

Features

Briefly, this library can:

  • Import multiple FASTA files
  • Fetch the available BIGSdb databases that is currently live and available
  • Fetch the available BIGSdb database schemas for a given MLST database
  • Retrieve exact/non-exact MLST allele variant IDs based off a sequence
  • Retrieve MLST sequence type IDs based off a sequence
  • Output all results to a single CSV

Furthermore, this library is highly asynchronous where any potentially blocking operation, ranging from parsing FASTAs to performing HTTP requests are at least asynchronous, if not fully multithreaded.

Usage

This library can be installed through pip. Learn how to setup and install pip first.

Then, it's as easy as running pip install autobigs-engine in any terminal that has pip in it's path (any terminal where pip --version returns a valid version and install path).

CLI usage

This is a independent python library and thus does not have any form of direct user interface. One way of using it could be to create your own Python script that makes calls to this libraries functions. Alternatively, you may use autobigs-cli, a Python package that implements a CLI for calling this library.

Project details


Download files

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

Source Distribution

autobigs_engine-0.7.2.tar.gz (18.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

autoBIGS.engine-0.7.2-py3-none-any.whl (20.9 kB view details)

Uploaded Python 3

File details

Details for the file autobigs_engine-0.7.2.tar.gz.

File metadata

  • Download URL: autobigs_engine-0.7.2.tar.gz
  • Upload date:
  • Size: 18.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.0

File hashes

Hashes for autobigs_engine-0.7.2.tar.gz
Algorithm Hash digest
SHA256 2b1d5d1a78c7b248e4eb3a94678f621a549ac8d11c278cb86a338744b74eb8a9
MD5 89dec169bb24159744c14d2273ad7eab
BLAKE2b-256 00588acfbc0309056337b1d3dfca1af4b9356447ec5120564d0cbda55d95c588

See more details on using hashes here.

File details

Details for the file autoBIGS.engine-0.7.2-py3-none-any.whl.

File metadata

File hashes

Hashes for autoBIGS.engine-0.7.2-py3-none-any.whl
Algorithm Hash digest
SHA256 dd86f8c696cab68192ffa8375d1d1e2efe10179c265211727eacc130056606fd
MD5 1436e8c8e9f9150f7f1996b34d0ee3aa
BLAKE2b-256 eb8235faacad6381aee6ce72db57279e4dfabc6e52c9dfd8b2996740ee4d49bf

See more details on using hashes here.

Supported by

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