Skip to main content

Python REST API for Entrez E-Utilities: stateless, easy to use, reliable.

Project description

Documentation Status

Python REST API for Entrez E-Utilities, aiming to be easy to use and reliable.

While other packages attempt to use stateful extensions (queries with history) which is error-prone and led to misleading results, this implementation: - avoids the problem altogether by not using such stateful API, - makes common tasks easy thanks to Pythonic API, - is typed and integrates well with mypy

Stats: Beta

from easy_entrez import EntrezAPI

entrez_api = EntrezAPI(
    'your-tool-name',
    'e@mail.com',
    # optional
    return_type='json'
)

# find up to 10 000 results for cancer in human
result = entrez_api.search('cancer AND human[organism]', max_results=10_000)

# data will be populated with JSON or XML (depending on the `return_type` value)
result.data

See more in the Demo notebook.

Installation

Requires Python 3.6+. Install with:

pip install easy-entrez

If you wish to enable (optional, tqdm-based) progress bars use:

pip install easy-entrez[with_progress_bars]

Alternatives:

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

easy_entrez-0.2.0.tar.gz (11.4 kB view details)

Uploaded Source

File details

Details for the file easy_entrez-0.2.0.tar.gz.

File metadata

  • Download URL: easy_entrez-0.2.0.tar.gz
  • Upload date:
  • Size: 11.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.8.6

File hashes

Hashes for easy_entrez-0.2.0.tar.gz
Algorithm Hash digest
SHA256 53fce4a46888585a933b73d3d5062eb59fcdc908ed963726c7bb5f72fd6c723d
MD5 6cabfb1410d37eff32b916b8f73f4ae5
BLAKE2b-256 ee204a65b9f0f23f18096b56a03c6ef97475163f009aff0908da317a6444f39c

See more details on using hashes here.

Supported by

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