Python client for the GBIF API
Source on GitHub at gbif/pygbif
Other GBIF clients:
- R: rgbif, ropensci/rgbif
- Ruby: gbifrb, sckott/gbifrb
- PHP: php-gbif, restelae/php-gbif
Contributing: CONTRIBUTING.md
Stable from pypi
pip install pygbifDevelopment version
[sudo] pip install git+git://github.com/gbif/pygbif.git#egg=pygbifpygbif 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
- Maps - Maps, get raster maps from GBIF as png or mvt
You can import the entire library, or each module individually as needed.
In addition there is a utils module, currently with one method: wkt_rewind, and a caching method to manage whether HTTP requests are cached or not. See ?pygbif.caching.
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 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 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
- download_citation
- download_describe
- download_sql
Example usage:
from pygbif import occurrences as occ
occ.search(taxonKey = 3329049)
occ.get(key = 252408386)
occ.count(isGeoreferenced = True)
occ.download('basisOfRecord = PRESERVED_SPECIMEN')
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")
occ.download_citation("0002526-241107131044228")
occ.download_describe("simpleCsv")
occ.download_sql("SELECT gbifid,countryCode FROM occurrence WHERE genusKey = 2435098")maps module API:
- map
Example usage:
from pygbif import maps
out = maps.map(taxonKey = 212, year = 1998, bin = "hex",
hexPerTile = 30, style = "classic-noborder.poly")
out.response
out.path
out.img
out.plot()
utils module API:
- wkt_rewind
Example usage:
from pygbif import utils
x = 'POLYGON((144.6 13.2, 144.6 13.6, 144.9 13.6, 144.9 13.2, 144.6 13.2))'
utils.wkt_rewind(x)- License: MIT, see LICENSE file
- Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
