Metadata-Version: 2.4
Name: pymed-iplweb
Version: 0.8.11
Summary: Python library for access to PubMed
Author-email: Gijs Wobben <gijswobben@gmail.com>
Maintainer-email: Michał Pasternak <michal.dtz@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/mpasternak/pymed-iplweb
Keywords: PubMed,PMC
Classifier: Topic :: Utilities
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENCE
License-File: AUTHORS.txt
Requires-Dist: requests>=2.20.0
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Dynamic: license-file

PyMed-iplweb - PubMed Access through Python
===========================================


.. image:: https://img.shields.io/pypi/v/pymed-iplweb.svg
        :target: https://pypi.python.org/pypi/pymed-iplweb

.. image:: https://github.com/mpasternak/pymed-iplweb/actions/workflows/tests.yml/badge.svg?branch=develop
        :target: https://github.com/mpasternak/pymed-iplweb/actions/workflows/tests.yml

.. image:: https://img.shields.io/pypi/pyversions/pymed-iplweb.svg
        :target: https://pypi.python.org/pypi/pymed-iplweb

.. image:: https://img.shields.io/badge/license-MIT-green.svg
        :target: https://github.com/mpasternak/pymed-iplweb/blob/master/LICENCE

PyMed is a Python library that provides access to PubMed through the
PubMed API. This is a fork, maintained by https://IPLweb.pl

Supported versions
------------------

.. list-table::
   :header-rows: 1

   * - Python
     - Django (optional)
   * - 3.10
     - 4.2 LTS, 5.0, 5.1, 5.2 LTS
   * - 3.11
     - 4.2 LTS, 5.0, 5.1, 5.2 LTS
   * - 3.12
     - 4.2 LTS, 5.0, 5.1, 5.2 LTS
   * - 3.13
     - 5.1, 5.2 LTS

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:

.. code:: python

   from pymed 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.

Notice of Non-Affiliation and Disclaimer
----------------------------------------

The author of this library is not affiliated, associated, authorized,
endorsed by, or in any way officially connected with PubMed, or any of
its subsidiaries or its affiliates. The official PubMed website can be
found at https://www.ncbi.nlm.nih.gov/pubmed/.

License
-------

This project is licensed under the MIT License - see the `LICENCE <LICENCE>`_ file for details.
