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.1.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.1-py3-none-any.whl (20.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: autobigs_engine-0.7.1.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.1.tar.gz
Algorithm Hash digest
SHA256 a83924a07b15aef11d6a33bd5fdd17acd53706dee193b638b6583fa2a7ea70ff
MD5 8a93bcbd812a7ac4a94c4da921166b83
BLAKE2b-256 95fdb07940ecfce27dbe833110293f2464ffec9da432c355bac74458cd37459e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for autoBIGS.engine-0.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 62ad1bb51afda1781479212290306b4331e503c425f7757b67e0707e0f7355ab
MD5 fca807e36f924009f0fa99dd86646e5c
BLAKE2b-256 6d79aed7c11902ba1b472c4f44ecbacc0e3620a521773917a13a74ce270fa603

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