Skip to main content

Download genome files from NCBI by accession.

Project description

NCBI accession download script

A partner script to the popular ncbi-genome-download script, ncbi-acc-download allows you to download sequences from GenBank/RefSeq by accession through the NCBI ENTREZ API.

Installation

pip install ncbi-acc-download

Alternatively, clone this repository from GitHub, then run (in a python virtual environment)

pip install .

If this fails on older versions of Python, try updating your pip tool first:

pip install --upgrade pip

and then rerun the ncbi-acc-download install.

ncbi-acc-download is only developed and tested on Python releases still under active support by the Python project. At the moment, this means versions 2.7, 3.4, 3.5, 3.6 and 3.7. Specifically, no attempt at testing under Python versions older than 2.7 or 3.4 is being made.

If your system is stuck on an older version of Python, consider using a tool like Homebrew or Linuxbrew to obtain a more up-to-date version.

Usage

To download a nucleotide record AB_12345 in GenBank format, run

ncbi-acc-download AB_12345

To download a nucleotide record AB_12345 in FASTA format, run

ncbi-acc-download --format fasta AB_12345

To download a protein record WP_12345 in FASTA format, run

ncbi-acc-download --molecule protein WP_12345

To just generate a list of download URLs to run the actual download elsewhere, run

ncbi-acc-download --url AB_12345

If you want to concatenate multiple sequences into a single file, run

ncbi-acc-download --out two_genomes.gbk AB_12345 AB_23456

You can use this with /dev/stdout as the filename to print the downloaded data to standard output instead of writing to a file if you want to chain ncbi-acc-download with other command line tools, like so:

ncbi-genome-download --out /dev/stdout --format fasta AB_12345 AB_23456 | gzip > two_genomes.fa.gz

You can get more detailed information on the download progress by using the --verbose or -v flag.

To get an overview of all options, run

ncbi-acc-download --help

License

All code is available under the Apache License version 2, see the LICENSE file for details.

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

ncbi-acc-download-0.2.0.tar.gz (6.9 kB view details)

Uploaded Source

Built Distribution

ncbi_acc_download-0.2.0-py2.py3-none-any.whl (7.6 kB view details)

Uploaded Python 2Python 3

File details

Details for the file ncbi-acc-download-0.2.0.tar.gz.

File metadata

  • Download URL: ncbi-acc-download-0.2.0.tar.gz
  • Upload date:
  • Size: 6.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/39.1.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.6.5

File hashes

Hashes for ncbi-acc-download-0.2.0.tar.gz
Algorithm Hash digest
SHA256 9b56ff179a4f097ef4637b8c7d8c5a9ecf44c799addfc79ce2fa1b75ddeacb17
MD5 8dd1384292cdba6c9923d8ac72654b64
BLAKE2b-256 745d97c7ed94f44d1c8843ffe63c7f22c7ae0f3eb4279f21b89dd5301bf54e9e

See more details on using hashes here.

File details

Details for the file ncbi_acc_download-0.2.0-py2.py3-none-any.whl.

File metadata

  • Download URL: ncbi_acc_download-0.2.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 7.6 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/39.1.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.6.5

File hashes

Hashes for ncbi_acc_download-0.2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1320fc3dfbb7d18f7c1dbbbcdd9aa248a86127dda0bfaa70b4d2aacbe31f9918
MD5 062bb88d39ba16d08daded1f05324e93
BLAKE2b-256 741b10807165ce328d40c5bcafcf20f371a0e7683ccbf5d1031c944a775254a0

See more details on using hashes here.

Supported by

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