Skip to main content

idigbio-python-client

https://img.shields.io/pypi/v/idigbio.svg https://img.shields.io/travis/iDigBio/idigbio-python-client.svg

A python client for the iDigBio iDigBio v2 API.

Installation

pip install idigbio

If you want to use the Pandas Data Frame interface you need to install pandas as well.

pip install idigbio pandas

Basic Usage

Returning JSON from the API.

import idigbio
api = idigbio.json()
json_output = api.search_records()

Returning a Pandas Data Frame.

import idigbio
api = idigbio.pandas()
pandas_output = api.search_records()

See the Search API docs for info about the endpoint parameters.

Examples

View a Record By UUID

import idigbio
api = idigbio.json()
record = api.view("records","1db58713-1c7f-4838-802d-be784e444c4a")

Search for a Record by scientific name

import idigbio
api = idigbio.json()
record_list = api.search_records(rq={"scientificname": "puma concolor"})

Search for Records that have images

import idigbio
api = idigbio.json()
record_list = api.search_records(rq={"scientificname": "puma concolor", "hasImage": True})

Search for a MediaRecords by record property

import idigbio
api = idigbio.json()
mediarecord_list = api.search_media(rq={"scientificname": "puma concolor", "hasImage": True})

Create a heat map for a genus

import idigbio
api = idigbio.json()
m = api.create_map(rq={"genus": "acer"}, t="geohash")
m.save_map_image("acer_map_geohash", 2)

Create a point map for a genus

import idigbio
api = idigbio.json()
m = api.create_map(rq={"genus": "acer"}, t="points")
m.save_map_image("acer_map_points", 2)

Create a zoomed in point map for a bounding box

import idigbio
api = idigbio.json()
bbox = {"type": "geo_bounding_box", "bottom_right": {"lat": 29.642979999999998, "lon": -82.00}, "top_left": {"lat": 29.66298, "lon": -82.35315800000001}}
m = api.create_map(
    rq={"geopoint": bbox}
)
m.save_map_image("test.png", None, bbox=bbox)

Create a summary of kingdom and phylum data

import idigbio
api = idigbio.json()
summary_data = api.top_records(fields=["kingdom", "phylum"])

Get the number of Records for a search by scientific name

import idigbio
api = idigbio.json()
count = api.count_records(rq={"scientificname": "puma concolor"})

Get the number of MediaRecords for a search by scientific name

import idigbio
api = idigbio.json()
count = api.count_media(rq={"scientificname": "puma concolor"})

Get the histogram of Collection Dates for a search by record property, for the last 10 years

import idigbio
api = idigbio.json()
histogram_data = api.datehist(
    rq={"scientificname": "puma concolor"},
    top_fields=["institutioncode"], min_date="2005-01-01")

Release History

0.6.1 (2016-04-08)

** Changes **

  • Add media_type to upload functionality.

0.6.0 (2016-03-30)

Changes

  • Make pandas an extra requirements, update docs

New

  • Specify auth for api backend

  • Upload image capability (requires auth)

0.5.0 (2016-02-24)

Changes

  • Don’t exclude data.* fields if requested specifically

  • Fix stats and datehist api calls to respect parameters; param names changed to use python style and match server params.

0.4.3 (2016-02-23)

Bugfixes

  • no results no longer errs in the pandas client.

  • limit correctly limits to specified record, not next larger batch size

Miscellaneous

  • Clarify targetted python versions

Metadata

Release files for idigbio 0.7.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for idigbio 0.7.2
File Size Uploaded
idigbio-0.7.2.tar.gz 8.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for idigbio 0.7.2
File Interpreter ABI Platform
idigbio-0.7.2.linux-x86_64.tar.gz Details

Total release size: 23.3 kB

Release files / idigbio-0.7.2.tar.gz

Download URL idigbio-0.7.2.tar.gz
Size 8.7 kB
Tags Source
SHA-256 checksum
How to use checksums
6293b17b195877f09470c276b25ceb44da9f32e6213b4b0c81e5f1b10d57e41a
BLAKE2b-256 checksum
How to use checksums
9815bdc4300c058be5274540dba9a532d279e5799883e32dedfebcbd7861aad3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / idigbio-0.7.2.linux-x86_64.tar.gz

Download URL idigbio-0.7.2.linux-x86_64.tar.gz
Size 14.6 kB
Tags Source
SHA-256 checksum
How to use checksums
63f5829492de6c9440752ffc10925ecf28b7223a6bc1a2c9256f06b1f7a779ca
BLAKE2b-256 checksum
How to use checksums
99ebb65214ac0dc7a84699ca7f5b8157618004a4dd49ebdeec396f43ecd7d177
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

0.8.5

1 release file

0.8.4

1 release file

0.8.3.3

1 release file

0.8.3.1

1 release file

0.8.3

1 release file

0.8.2

1 release file

0.8.1

1 release file

0.8.0

3 release files

This release

0.7.2 This release

2 release files

0.7.1

2 release files

0.7.0

2 release files

0.6.1

2 release files

0.6.0

1 release file

0.5.0

1 release file

0.4.3

1 release file

0.4.2

1 release file

0.4.1

1 release file

0.4.0

1 release file

0.3.0

2 release files

0.2.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page