entrezpy 2.1.3

Dedicated library to query and retrieve data from Entrez databases at NCBI

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.

Licence and Copyright

entrezpy is licensed under the GNU Lesser General Public License v3 (LGPLv3) or later. Please see https://www.ncbi.nlm.nih.gov/home/about/policies/ concerning the copyright of the material available through E-Utilities.

Please cite the publication if you use entrezpy.

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

[Entrez2016]

https://doi.org/10.1093/nar/gkw1071

[Sayers2018]

https://www.ncbi.nlm.nih.gov/books/NBK25497