Skip to main content

Python client library for Index Herbariorum API Web Services

Project description

index-herbariorum-python-client
=====================

A python client library for the `Index Herbariorum https://github.com/nybgvh/IH-API/wiki` API.

To contribute code to this project, please submit a pull request to the repo on github:

https://github.com/jlramirez/index-herbariorum-python-client

Installation
------------

.. code-block::

pip install indexherbariorum

Usage
-----------

Get all available countries

.. code-block:: python

import indexherbariorum

ih = indexherbariorum.init()
countries_result = ih.countries()

Search for an institution by code

.. code-block:: python

import indexherbariorum

ih = indexherbariorum.init()
institution_result = ih.institution('ala')

Search institutions by matching a specified query

.. code-block:: python

import indexherbariorum

ih = indexherbariorum.init()
institutions_result = ih.institutions(rq={'state': 'california', 'city': 'los angeles'})

Search staff by matching a specified query

.. code-block:: python

import indexherbariorum

ih = indexherbariorum.init()
staff_result = ih.staff(rq={'state': 'new york', 'correspondent': 'yes'})

Get number of countries

.. code-block:: python

import indexherbariorum

ih = indexherbariorum.init()
count = ih.count_countries()

Get number of institution records based on search

.. code-block:: python

import indexherbariorum

ih = indexherbariorum.init()
count = ih.count_institutions(rq={'country': 'colombia', 'city': 'medellin'})

Get number of staff records based on search

.. code-block:: python

import indexherbariorum

ih = indexherbariorum.init()
count = ih.count_staff(rq={'state': 'texas', 'correspondent': 'yes'})

Download CSV file

.. code-block:: python

import indexherbariorum

ih = indexherbariorum.init()
ih.download('staff', rq={'state': 'new york', 'correspondent': 'yes'}, filename='ny_staff.csv')

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

indexherbariorum-1.0.0.tar.gz (3.9 kB view details)

Uploaded Source

File details

Details for the file indexherbariorum-1.0.0.tar.gz.

File metadata

File hashes

Hashes for indexherbariorum-1.0.0.tar.gz
Algorithm Hash digest
SHA256 3cce00885d1c9d1f076c3793aaea6cc4af4e9da874fa5db23faf976522cac92b
MD5 83e12d1507dbf41ba1506d8075d1ff86
BLAKE2b-256 ac189d9ec62f8ef4ce35f6aaabde22e1d342d8f6d7d4d67970ca745ca01b7c16

See more details on using hashes here.

Supported by

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