Skip to main content

Python client for GBIF

Project description

pyobis

docs travis coverage

Python client for the OBIS API.

Source on GitHub at sckott/pyobis

Other OBIS clients:

Installation

from pypi

pip install pyobis

dev version

pip install git+git://github.com/sckott/pyobis.git#egg=pyobis

library API

pyobis is split up into modules for each of the groups of API methods.

  • taxa - Taxonomic names
  • occurrences - Occurrence search, and occurrence downloads
  • resources - Resources
  • groups - Groups
  • nodes - Nodes
  • checklist - Checklist

You can import the entire library, or each module individually as needed.

Taxa module

from pyobis import taxa
taxa.search(scientificname = 'Mola mola')
taxa.search(scientificname = 'Mola mola', offset=10, limit=10)
taxa.search(geometry='POLYGON((30.1 10.1, 10 20, 20 40, 40 40, 30.1 10.1))', limit=20)
taxa.search(aphiaid=key, year="2013", limit=20)
taxa.taxon(406296)
taxa.taxon(415282)

Occurrence module

Search

from pyobis import occurrences
occurrences.search(scientificname = 'Mola mola')
occurrences.search(scientificname = 'Mola mola', offset=0, limit=10)
occurrences.search(geometry='POLYGON((30.1 10.1, 10 20, 20 40, 40 40, 30.1 10.1))', limit=20)
occurrences.search(aphiaid=key, year="2013", limit=20)

Download

res = occ.download(year = 2001, scientificname = 'Orcinus')
res.uuid
res.status()
res.fetch()

Resources module

from pyobis import resources
resources.search(scientificname = ['Mola', 'Abra', 'Lanice', 'Pectinaria'])
resources.resource(103)
resources.citation(scientificname = 'Mola mola')

Groups module

from pyobis import groups
groups.group()
groups.group(limit = 3)

Ndes module

from pyobis import nodes
nodes.node()

Checklist module

from pyobis import checklist as ch
ch.list(year = 2005, scientificname = 'Cetacea')

Meta

Changelog

0.1.0 (2016-12-12)

  • first push to pypi
  • finished off all OBIS API routes

0.0.6.9000 (2016-05-12)

  • Updated modules with missing methods
  • Added modules: groups, resources
  • Removed taxon module, just a taxa module now that has all taxa/taxon methods
  • Updated docs

0.0.1 (2015-12-11)

  • in the works…not on pypi yet

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pyobis, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size pyobis-0.1.0-py2.py3-none-any.whl (19.4 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size pyobis-0.1.0.tar.gz (11.1 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page