Skip to content

Commit

Permalink
readme.md to readme.rst, hpefully fixes how it lokos on pypi
Browse files Browse the repository at this point in the history
  • Loading branch information
sckott committed Nov 4, 2015
1 parent 9e3aa84 commit 5023b5b
Show file tree
Hide file tree
Showing 3 changed files with 76 additions and 65 deletions.
64 changes: 0 additions & 64 deletions README.md

This file was deleted.

75 changes: 75 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
pygbif
=======

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

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

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

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

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
occurrences.search(taxonKey = 3329049)
occurrences.get(taxonKey = 252408386)
occurrences.count(isGeoreferenced = True)
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.
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
from setuptools import setup
from setuptools import find_packages

with codecs.open('README.md', 'r', 'utf-8') as f:
with codecs.open('README.rst', 'r', 'utf-8') as f:
readme = f.read()

with codecs.open('CHANGES.txt', 'r', 'utf-8') as f:
Expand Down

0 comments on commit 5023b5b

Please sign in to comment.