Skip to main content
Documentation Status PyPI - Python Version PyPI - License PyPI PyPI - Format PyPI - Status

Entrezpy README

Synopsis

$ pip install entrezpy --user
>>> import entrezpy.conduit
>>> w = entrezpy.conduit.Conduit('myemail')
>>> fetch_influenza = w.new_pipeline()
>>> sid = fetch_influenza.add_search({'db' : 'nucleotide', 'term' : 'H3N2 [organism] AND HA', 'rettype':'count', 'sort' : 'Date Released', 'mindate': 2000, 'maxdate':2019, 'datetype' : 'pdat'})
>>> fid = fetch_influenza.add_fetch({'retmax' : 10, 'retmode' : 'text', 'rettype': 'fasta'}, dependency=sid)
>>> w.run(fetch_influenza)

Entrezpy is a dedicated Python library to interact with NCBI Entrez databases [Entrez2016] via the E-Utilities ([Sayers2018], E-Utilities). Entrezpy facilitates the implementation of queries to query or download data from the Entrez databases, e.g. search for specific sequences or publications or fetch your favorite genome. For more complex queries entrezpy offers the class entrezpy.conduit.Conduit to run query pipelines or cache results.

Installation

Entrezpy requires at least Python 3.6 and the Standars Python Library.

PyPi

Install entrezpy via PyPi and check:

$ pip install entrezpy --user

If you want to incude entrezpy as part of your pipeline, check the documentation (https://entrezpy.readthedocs.io/en/master/setup/installation.html#append-to-sys-path)

Documentation

Entrezpy is fully documented using Spinx (http://www.sphinx-doc.org/en/stable/). The manual, usage examples and module reference can be found here: http://entrezpy.readthedocs.io/

entrezpy has been published in Bioinformatics: https://doi.org/10.1093/bioinformatics/btz385

References

Metadata

Release files for entrezpy 2.1.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for entrezpy 2.1.3
File Size Uploaded
entrezpy-2.1.3.tar.gz 42.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for entrezpy 2.1.3
File Interpreter ABI Platform
entrezpy-2.1.3-py3-none-any.whl Python 3 none any Details

Total release size: 129.9 kB

Release files / entrezpy-2.1.3.tar.gz

Download URL entrezpy-2.1.3.tar.gz
Size 42.8 kB
Tags Source
SHA-256 checksum
How to use checksums
4f73701606bba2c6f82b66f72328f1df76050d6dfe61ecdcf797a7183adc484e
BLAKE2b-256 checksum
How to use checksums
259725555e51f5f7c26671866e4ac9ba70a0cebca22389c1f059d5f067ab8cfc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

Release files / entrezpy-2.1.3-py3-none-any.whl

Download URL entrezpy-2.1.3-py3-none-any.whl
Size 87.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9223b61cd6b88181114b19abc45b746b75ad26a35384d5256ce00665de121802
BLAKE2b-256 checksum
How to use checksums
e8f92f5a3b3aa9df0a507f27338dc0e8a55aa1b180ddacbf326fa6b4c4687576
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page