ydeng/autoBIGS.cli
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added a planned features section on the README.md

Browse Source
This commit is contained in:
Harrison Deng
2025-01-23 16:07:52 +00:00
parent 53cd2e1260
commit 2f189c8741
1 changed files with 11 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -1,19 +1,25 @@
# autoBIGS.CLI
# autoBIGS.cli
A command-line interface based program that allows quickly batched requests for obtaining MLST profiles on multiple FASTA sequences and exporting it as a convenient CSV.
A command-line interface (CLI) based program that allows quickly batched requests for obtaining MLST profiles on multiple FASTA sequences and exporting it as a convenient CSV. Capable of querying a variety of MLST databases from both Institut Pasteur and PubMLST.
This program is simply a command-line interface for [autoBIGS.Engine](https://pypi.org/project/autoBIGS.engine).
This program is simply a command-line interface for [autoBIGS.engine](https://pypi.org/project/autoBIGS.engine).
## Features
This CLI is capable of exactly what [autoBIGS.Engine](https://pypi.org/project/autoBIGS.engine) is capable of:
- Import multiple FASTA files
This CLI is capable of exactly what [autoBIGS.engine](https://pypi.org/project/autoBIGS.engine) is capable of:
- Import multiple whole genome 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
## Planned Features for CLI
- Specifications of multi-threading capacity
- Session authentication for updated database schemas (as required by both PubMLST and Institut Pasteur)
Please refer to [autoBIGS.engine](https://pypi.org/project/autoBIGS.engine) for more planned features.
## Usage
This CLI can be installed with `pip`. Please ensure [pip is installed](https://pip.pypa.io/en/stable/installation/). Then: