pygbif

pypi docs travis coverage

Python client for the GBIF API

Source on GitHub at sckott/pygbif

Other GBIF clients:

Installation

Stable from pypi

pip install pygbif

Development version

[sudo] pip install git+git://github.com/sckott/pygbif.git#egg=pygbif

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

  • Registry - Datasets, Nodes, Installations, Networks, Organizations
  • Species - Taxonomic names
  • Occurrences - Occurrence data, including the download API

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

Note that GBIF maps API is not included in pygbif.

Registry module

registry module API:

  • organizations
  • nodes
  • networks
  • installations
  • datasets
  • dataset_metrics
  • dataset_suggest
  • dataset_search

Example usage:

from pygbif import registry
registry.dataset_metrics(uuid='3f8a1297-3259-4700-91fc-acc4170b27ce')

Species module

species module API:

  • name_backbone
  • name_suggest
  • name_usage
  • name_lookup
  • name_parser

Example usage:

from pygbif import species
species.name_suggest(q='Puma concolor')

Occurrences module

registry module API:

  • search
  • get
  • get_verbatim
  • get_fragment
  • count
  • count_basisofrecord
  • count_year
  • count_datasets
  • count_countries
  • count_schema
  • count_publishingcountries
  • download
  • download_meta
  • download_list
  • download_get

Example usage:

from pygbif import occurrences as occ
occ.search(taxonKey = 3329049)
occ.get(key = 252408386)
occ.count(isGeoreferenced = True)
occ.download('basisOfRecord = LITERATURE')
occ.download('taxonKey = 3119195')
occ.download('decimalLatitude > 50')
occ.download_list(user = "sckott", limit = 5)
occ.download_meta(key = "0000099-140929101555934")
occ.download_get("0000066-140928181241064")

Meta

License

MIT

Indices and tables