Skip to main content

Python library for access to PubMed -- fork from archived PyMed

Project description

NOTE: This is a user-maintained extension of the pymed project which was archived in 2020. Some bugs in pymed are fixed here. This package can be installed via pip install pymed-paperscraper since I forked it to support paperscraper.

License: MIT PyPI version Downloads Downloads

PyMed - PubMed Access through Python

PyMed is a Python library that provides access to PubMed through the PubMed API.

Why this library?

The PubMed API is not very well documented and querying it in a performant way is too complicated and time consuming for researchers. This wrapper provides access to the API in a consistent, readable and performant way.

Features

This library takes care of the following for you:

  • Querying the PubMed database (with the standard PubMed query language)
  • Batching of requests for better performance
  • Parsing and cleaning of the retrieved articles

Examples

For full (working) examples have a look at the examples/ folder in this repository. In essence you only need to import the PubMed class, instantiate it, and use it to query:

from pymed_paperscraper import PubMed
pubmed = PubMed(tool="MyTool", email="my@email.address")
results = pubmed.query("Some query", max_results=500)

Bugfixes compared to archived pymed:

  • Article IDs are correctly extracted pymed#22
  • Automatic retries if API is unresponsive/overloaded. Support for max_tries in PubMed class.

Notes on the API

The original documentation of the PubMed API can be found here: PubMed Central. PubMed Central kindly requests you to:

  • Do not make concurrent requests, even at off-peak times; and
  • Include two parameters that help to identify your service or application to our servers
    • tool should be the name of the application, as a string value with no internal spaces, and
    • email should be the e-mail address of the maintainer of the tool, and should be a valid e-mail address.

Citation

If you use pymed_paperscraper in your work, please cite:

(Citation follows)

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

pymed_paperscraper-1.0.4.tar.gz (259.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pymed_paperscraper-1.0.4-py3-none-any.whl (11.1 kB view details)

Uploaded Python 3

File details

Details for the file pymed_paperscraper-1.0.4.tar.gz.

File metadata

  • Download URL: pymed_paperscraper-1.0.4.tar.gz
  • Upload date:
  • Size: 259.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for pymed_paperscraper-1.0.4.tar.gz
Algorithm Hash digest
SHA256 ba20817714bce3b24bad96dfe2c1bb092f4fc091b9044a8cc636198020795655
MD5 52440dd1a4e5a37e245e03887a2861bc
BLAKE2b-256 4a424198169379590994acd295208f3b887124bc8aa2936a3bbe09419e0dd24a

See more details on using hashes here.

File details

Details for the file pymed_paperscraper-1.0.4-py3-none-any.whl.

File metadata

File hashes

Hashes for pymed_paperscraper-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 e32b2e030334dfc931c6c47ac9d856b43cd19b9ac2b886cb5eb0a7216d940523
MD5 cd9fe9ddfe59406f861aef4686320e0f
BLAKE2b-256 523a0e0c97b4341a375a5b7b98a0ca15608391a1581f0d49cf1c8138eb1c288b

See more details on using hashes here.

Supported by

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