Skip to main content

Python client for GBIF

Project description

pygbif
=======

|pypi| |docs| |travis| |coverage|

Python client for the `GBIF API
<http://www.gbif.org/developer/summary>`__.

`Source on GitHub at sckott/pygbif <https://github.com/sckott/pygbif>`__

Other GBIF clients:

* R: `rgbif`, `ropensci/rgbif <https://github.com/ropensci/rgbif>`__

Installation
============

Stable from pypi

.. code-block:: console

pip install pygbif

Development version

.. code-block:: console

[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 <http://www.gbif.org/developer/maps>`__ is not included in `pygbif`.

Registry module
===============

.. code-block:: python

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

Species module
===============

.. code-block:: python

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

Occurrences module
==================

.. code-block:: python

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


Meta
====

* License: MIT, see `LICENSE file <LICENSE>`__
* Please note that this project is released with a `Contributor Code of Conduct <CONDUCT.md>`__. By participating in this project you agree to abide by its terms.

.. |pypi| image:: https://img.shields.io/pypi/v/pygbif.svg
:target: https://pypi.python.org/pypi/pygbif

.. |docs| image:: https://readthedocs.org/projects/pygbif/badge/?version=latest
:target: http://pygbif.rtfd.org/

.. |travis| image:: https://travis-ci.org/sckott/pygbif.svg
:target: https://travis-ci.org/sckott/pygbif

.. |coverage| image:: https://coveralls.io/repos/sckott/pygbif/badge.svg?branch=master&service=github
:target: https://coveralls.io/github/sckott/pygbif?branch=master


Changelog
=======

0.1.4 (2016-06-04)
--------------------
- Added variable types throughout docs
- Changed default `limit` value to 300 for `occurrences.search` method
- `tox` now included, via @xrotwang (#20)
- Added more registry methods (#11)
- Started occurrence download methods (#16
- Added more names methods (#18)
- All requests now send user-agent headers with `requests` and `pygbif` versions (#13)
- Bug fix for `occurrences.download_get` (#23)
- Fixed bad example for `occurrences.get` (#22)
- Fixed wheel to be universal for 2 and 3 (#10)
- Improved documentation a lot, autodoc methods now

0.1.1 (2015-11-03)
--------------------
- Fixed distribution for pypi

0.1.0 (2015-11-02)
--------------------
- First release

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

pygbif-0.1.4.tar.gz (27.1 kB view details)

Uploaded Source

Built Distribution

pygbif-0.1.4-py2.py3-none-any.whl (38.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file pygbif-0.1.4.tar.gz.

File metadata

  • Download URL: pygbif-0.1.4.tar.gz
  • Upload date:
  • Size: 27.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for pygbif-0.1.4.tar.gz
Algorithm Hash digest
SHA256 c4c749716346a56c6176f072f937c0e8ae0adfb3973d26fdb3666bd727db6e78
MD5 0b44c0f4338f50c3dd2a2539093bb9d3
BLAKE2b-256 6565536c1740bc8bbc9ceb07290201dd7aa4aa8b025b8b52db2046ba1a7fc864

See more details on using hashes here.

File details

Details for the file pygbif-0.1.4-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for pygbif-0.1.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6389b284a317e316817318a2a9bcb84e165d41f18c480fccfe82721e6ccb2e10
MD5 ffdf6444b9ddecfadee2b03a99bb15da
BLAKE2b-256 800de677e5b05b8d16d65aa28f7a13c1f3ac3319cd2747d871b6a5ba2f609233

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