# Makura: NCBI Genome downloader
## Requirements
rsync (linux command, required for downloading NCBI genomes)
python 3.8 (or greater)
## Installation
### Rsync ` conda install -c conda-forge rsync # or sudo apt install rsync `
### Python packages
https://pypi.org/project/makura/
install from Pypi
` pip install makura `
install locally ` python setup.py install `
install from docker ` docker pull hunglin59638/makura `
## Usage
Update the assembly summary and taxonomy information while first using. ` makura update ` It’s ok that you don’t run the command, makura will automatically update if the assembly summary is not found.
Download bacteria and fungi genomes with complete assembly level in RefSeq database.
` makura download --group bacteria,fungi --assembly-level complete --assembly-source refseq --out_dir /path/to/dir `
Print the records of genomes with JSON lines format, default is TAB ` makura summary --accession GCF_016700215.2 --as-json-lines `
Download genomes with selected taxids ` makura download --taxid 2209 `
If you have many items to input, input a file contains lines is supported. Example: taxid_list.txt ` 61645 69218 550 `
` makura download --taxid-list taxid_list.txt --out_dir /path/to/dir `
Tips:
Running with multiple downloads in parallel is supported (Default: 4). We set the maximum is 8 to avoid NCBI blocks the downloads. ` makura download --group bacteria,fungi --parallel 4 `
While downloading the genomes, makura can check the MD5 checksum of them. The MD5 values was stored to a file named md5checksums.txt in output directory.
## Developing function Using the RESTful API to get assembly summary 1. run the API server ` docker run --rm -p 5000:5000 hunglin59638/makura:1.1.0 makura api --port 5000 ` 2. get the summary of assembly accessions ` curl http://localhost:5000/summary?accessions=GCA_002287175.1,GCA_000762265.1 ` ## Features in the future - Creating minimap2 and bwa index using downloaded genomes. - Downloading genomes by organism name, biosample, bioproject, etc.
Metadata
Release files for makura 1.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| makura-1.2.0.tar.gz | 23.3 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| makura-1.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 45.9 kB
Release files / makura-1.2.0.tar.gz
| Download URL | makura-1.2.0.tar.gz |
|---|---|
| Size | 23.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9fc0ea7da973f6f7591c1ab65fa6e7d98077751f989feb0926e42b99d833dcb3
|
|
BLAKE2b-256 checksum How to use checksums |
27726835cc5f6dd34807d94db41d00a2df0e630859d440976096c35ffb346901
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.6
|
Release files / makura-1.2.0-py3-none-any.whl
| Download URL | makura-1.2.0-py3-none-any.whl |
|---|---|
| Size | 22.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9112ac4323bdd39766ca9585c68d2c6293f9c468c968366eefe629083d78f780
|
|
BLAKE2b-256 checksum How to use checksums |
77449658f0ee196594a9ed2c9739bb53bbc25a569b715dc85e09eb78f5044e8e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.6
|
Security for makura 1.2.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.