.. PyPump documentation master file, created by
   sphinx-quickstart on Mon May 27 12:57:47 2013.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

PyPump - Python Pump.io Library
===============================

Release v\ |release|.

PyPump is a simple but powerful and pythonic way of interfacing with the `pump.io <http://pump.io>`_ API.

PyPump is under the `GPLv3 <https://www.gnu.org/licenses/gpl.html>`_. You should probably
look to see if/how this may impact you and your programs if you wish to use PyPump. The community
for PyPump lives on IRC in the #pypump channel on `MegNet <https://megworld.co.uk/irc>`_.

Getting started
---------------
If you're new to PyPump and feeling a bit overwhelmed the :doc:`gettingstarted/tutorial` is the best
place to go, however if you're familiar with python and understand pump, check out the
:doc:`gettingstarted/qnd` guide!

.. toctree::
   :caption: User documentation
   :maxdepth: 1

   gettingstarted/installing
   gettingstarted/qnd
   gettingstarted/tutorial
   gettingstarted/authentication
   gettingstarted/verifier_callback
   gettingstarted/webpump

   store

   common/media


.. toctree::
   :caption: API documentation
   :maxdepth: 1

   classref


About PyPump
============

.. toctree::
    :maxdepth: 2
    :caption: Version history

    changelog

Links
-----
* `PyPump on Github <https://github.com/xray7224/PyPump>`_
* `PyPump on PyPI <https://pypi.python.org/pypi/pypump>`_


This was build on |today|
