NOTE: This is a user-maintained extension of the [pymed](https://pypi.org/project/pymed/) project which was [archived in 2020](https://github.com/gijswobben/pymed). Some bugs in `pymed` are fixed here. This package can be installed via `pip install pymed-paperscraper` since I forked it to support [`paperscraper`](https://github.com/jannisborn/paperscraper).
[](https://opensource.org/licenses/MIT)
[](https://badge.fury.io/py/pymed_paperscraper)
[](https://pepy.tech/project/pymed_paperscraper)
[](https://pepy.tech/project/pymed_paperscraper)
# 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:
```python
from pymed_paperscraper import PubMed
pubmed = PubMed(tool="MyTool", email="my@email.address")
results = pubmed.query("Some query", max_results=500)
```
## Notes on the API
The original documentation of the PubMed API can be found here: [PubMed Central](https://www.ncbi.nlm.nih.gov/pmc/tools/developers/). 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.
Raw data
{
"_id": null,
"home_page": null,
"name": "pymed-paperscraper",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "PubMed, Academics, Science, Publication, Search",
"author": null,
"author_email": "Jannis Born <jannis.born@gmx.de>",
"download_url": "https://files.pythonhosted.org/packages/7d/ea/fa90923f558e4ed2b986abd278acb9ba402eae539ae3830e2a57b8e45aa7/pymed_paperscraper-1.0.3.tar.gz",
"platform": null,
"description": "NOTE: This is a user-maintained extension of the [pymed](https://pypi.org/project/pymed/) project which was [archived in 2020](https://github.com/gijswobben/pymed). Some bugs in `pymed` are fixed here. This package can be installed via `pip install pymed-paperscraper` since I forked it to support [`paperscraper`](https://github.com/jannisborn/paperscraper).\n\n[](https://opensource.org/licenses/MIT)\n[](https://badge.fury.io/py/pymed_paperscraper)\n[](https://pepy.tech/project/pymed_paperscraper)\n[](https://pepy.tech/project/pymed_paperscraper)\n\n# PyMed - PubMed Access through Python\nPyMed is a Python library that provides access to PubMed through the PubMed API.\n\n## Why this library?\nThe 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.\n\n## Features\nThis library takes care of the following for you:\n\n- Querying the PubMed database (with the standard PubMed query language)\n- Batching of requests for better performance\n- Parsing and cleaning of the retrieved articles\n\n## Examples\nFor 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:\n\n```python\nfrom pymed_paperscraper import PubMed\npubmed = PubMed(tool=\"MyTool\", email=\"my@email.address\")\nresults = pubmed.query(\"Some query\", max_results=500)\n```\n\n## Notes on the API\nThe original documentation of the PubMed API can be found here: [PubMed Central](https://www.ncbi.nlm.nih.gov/pmc/tools/developers/). PubMed Central kindly requests you to:\n\n> - Do not make concurrent requests, even at off-peak times; and\n> - Include two parameters that help to identify your service or application to our servers\n> * _tool_ should be the name of the application, as a string value with no internal spaces, and\n> * _email_ should be the e-mail address of the maintainer of the tool, and should be a valid e-mail address.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python library for access to PubMed -- fork from archived PyMed",
"version": "1.0.3",
"project_urls": {
"Homepage": "https://github.com/jannisborn/pymed"
},
"split_keywords": [
"pubmed",
" academics",
" science",
" publication",
" search"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "2f2660207009f8ac07d8d0fa78293ff4057158ac30df8dd517d4fc6daea4b58f",
"md5": "9b0716b387b807936c19b876ca61dacb",
"sha256": "fedb4d81f283dad8c64386b11e0f6272e50a7cc6a813c3c779b82bff66fcb5ae"
},
"downloads": -1,
"filename": "pymed_paperscraper-1.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9b0716b387b807936c19b876ca61dacb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 10420,
"upload_time": "2025-02-23T13:54:18",
"upload_time_iso_8601": "2025-02-23T13:54:18.438337Z",
"url": "https://files.pythonhosted.org/packages/2f/26/60207009f8ac07d8d0fa78293ff4057158ac30df8dd517d4fc6daea4b58f/pymed_paperscraper-1.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "7deafa90923f558e4ed2b986abd278acb9ba402eae539ae3830e2a57b8e45aa7",
"md5": "d2a86291e080f08f2d7cdb18c59249cb",
"sha256": "638957c4879215bb85a49a33623b922b522d86402884e8ff7ca7af5b42cd8f0a"
},
"downloads": -1,
"filename": "pymed_paperscraper-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "d2a86291e080f08f2d7cdb18c59249cb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 258239,
"upload_time": "2025-02-23T13:54:20",
"upload_time_iso_8601": "2025-02-23T13:54:20.973995Z",
"url": "https://files.pythonhosted.org/packages/7d/ea/fa90923f558e4ed2b986abd278acb9ba402eae539ae3830e2a57b8e45aa7/pymed_paperscraper-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-23 13:54:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jannisborn",
"github_project": "pymed",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "requests",
"specs": [
[
">=",
"2.20.0"
]
]
},
{
"name": "gitpython",
"specs": [
[
">=",
"2.1.11"
]
]
},
{
"name": "twine",
"specs": [
[
">=",
"1.12.1"
]
]
},
{
"name": "tqdm",
"specs": []
}
],
"lcname": "pymed-paperscraper"
}
JSON
