Interact with US NLM Daily Med API using Python.
Project description
|License MIT| | |Build Status| | |Coveralls Status| | |Codecov Status| | |Code Climate|
================
Python Daily Med
================
This library interacts with the United States National Library of Medicine's Daily
Med API.
Installation
============
* Install Python requirements ``pip install -r ./requirements``
Setup
=====
*
Usage
=====
* `Read The API Documentation <https://laslabs.github.io/python-daily-med>`_
Import and Instantiate
----------------------
Importing an instantiating the Daily Med object:
.. code-block:: python
from daily_med import DailyMed
dm = DailyMed()
Structured Product Label Metadata
---------------------------------
`get_spls` mirrors the `/spls` interface as documented `here
<https://dailymed.nlm.nih.gov/dailymed/webservices-help/v2/spls_api.cfm`_.
To get an iterator of all SPLs:
.. code-block:: python
spl_metas = dm.get_spls()
You can also perform an SPL search using any of the standard query parameters:
.. code-block:: python
simvastatin_metas = dm.get_spls(drug_name='Simvastatin')
Structured Product Label Documents
----------------------------------
Once you have a `set_id` for an SPL, you can get its document:
.. code-block:: python
spl_document = dm.get_spl('0be2e371-1f05-48d7-8f2e-f2024f3305f3')
An SPL Document is basically just a dictionary representing the parsed XML
document.
Known Issues / Road Map
=======================
- SPLDocument is only Python 2 compatible. Generate a Python3 version and integrate
an import switch for py2/3. Downfall is that this will add another 6mb of code to
the repo & coverage will be inaccurate because not everything is testable at once.
Credits
=======
Images
------
* LasLabs: `Icon <https://repo.laslabs.com/projects/TEM/repos/odoo-module_template/browse/module_name/static/description/icon.svg?raw>`_.
Contributors
------------
* Dave Lasley <dave@laslabs.com>
Maintainer
----------
.. image:: https://laslabs.com/logo.png
:alt: LasLabs Inc.
:target: https://laslabs.com
This module is maintained by LasLabs Inc.
.. |Build Status| image:: https://api.travis-ci.org/LasLabs/python-daily-med.svg?branch=master
:target: https://travis-ci.org/LasLabs/python-daily-med
.. |Coveralls Status| image:: https://coveralls.io/repos/LasLabs/python-daily-med/badge.svg?branch=master
:target: https://coveralls.io/r/LasLabs/python-daily-med?branch=master
.. |Codecov Status| image:: https://codecov.io/gh/LasLabs/python-daily-med/branch/master/graph/badge.svg
:target: https://codecov.io/gh/LasLabs/python-daily-med
.. |Code Climate| image:: https://codeclimate.com/github/LasLabs/python-daily-med/badges/gpa.svg
:target: https://codeclimate.com/github/LasLabs/python-daily-med
.. |License MIT| image:: https://img.shields.io/badge/license-MIT-blue.svg
:target: https://opensource.org/licenses/MIT
:alt: License: AGPL-3
================
Python Daily Med
================
This library interacts with the United States National Library of Medicine's Daily
Med API.
Installation
============
* Install Python requirements ``pip install -r ./requirements``
Setup
=====
*
Usage
=====
* `Read The API Documentation <https://laslabs.github.io/python-daily-med>`_
Import and Instantiate
----------------------
Importing an instantiating the Daily Med object:
.. code-block:: python
from daily_med import DailyMed
dm = DailyMed()
Structured Product Label Metadata
---------------------------------
`get_spls` mirrors the `/spls` interface as documented `here
<https://dailymed.nlm.nih.gov/dailymed/webservices-help/v2/spls_api.cfm`_.
To get an iterator of all SPLs:
.. code-block:: python
spl_metas = dm.get_spls()
You can also perform an SPL search using any of the standard query parameters:
.. code-block:: python
simvastatin_metas = dm.get_spls(drug_name='Simvastatin')
Structured Product Label Documents
----------------------------------
Once you have a `set_id` for an SPL, you can get its document:
.. code-block:: python
spl_document = dm.get_spl('0be2e371-1f05-48d7-8f2e-f2024f3305f3')
An SPL Document is basically just a dictionary representing the parsed XML
document.
Known Issues / Road Map
=======================
- SPLDocument is only Python 2 compatible. Generate a Python3 version and integrate
an import switch for py2/3. Downfall is that this will add another 6mb of code to
the repo & coverage will be inaccurate because not everything is testable at once.
Credits
=======
Images
------
* LasLabs: `Icon <https://repo.laslabs.com/projects/TEM/repos/odoo-module_template/browse/module_name/static/description/icon.svg?raw>`_.
Contributors
------------
* Dave Lasley <dave@laslabs.com>
Maintainer
----------
.. image:: https://laslabs.com/logo.png
:alt: LasLabs Inc.
:target: https://laslabs.com
This module is maintained by LasLabs Inc.
.. |Build Status| image:: https://api.travis-ci.org/LasLabs/python-daily-med.svg?branch=master
:target: https://travis-ci.org/LasLabs/python-daily-med
.. |Coveralls Status| image:: https://coveralls.io/repos/LasLabs/python-daily-med/badge.svg?branch=master
:target: https://coveralls.io/r/LasLabs/python-daily-med?branch=master
.. |Codecov Status| image:: https://codecov.io/gh/LasLabs/python-daily-med/branch/master/graph/badge.svg
:target: https://codecov.io/gh/LasLabs/python-daily-med
.. |Code Climate| image:: https://codeclimate.com/github/LasLabs/python-daily-med/badges/gpa.svg
:target: https://codeclimate.com/github/LasLabs/python-daily-med
.. |License MIT| image:: https://img.shields.io/badge/license-MIT-blue.svg
:target: https://opensource.org/licenses/MIT
:alt: License: AGPL-3
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
python-daily-med-0.1.0b72.tar.gz
(313.3 kB
view hashes)
Built Distribution
Close
Hashes for python-daily-med-0.1.0b72.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9c7a03ee7d75edb775a9ff2b4813d6664bc7bec54d1a651ddfcfb4a60a835d84 |
|
MD5 | 4d33ffb6424728c11b62f201ea737f8b |
|
BLAKE2b-256 | b7ab23421f139385b5735f500a33877094cfec0bfd62d7a421d808f94f3a9f49 |
Close
Hashes for python_daily_med-0.1.0b72-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a163d062da187327f52a3b45989added7609a04b251cfaae952016571b709cd3 |
|
MD5 | 86987f2dab33e4a7c3026e85f00f7f4c |
|
BLAKE2b-256 | 3219a73ce32283d52085ad7b47c8f300a583f59948203e23fa9cd637b8765e1c |