.. image:: https://travis-ci.org/xray7224/PyPump.svg?branch=master
       :target: https://travis-ci.org/xray7224/PyPump

.. image:: https://codecov.io/github/xray7224/PyPump/coverage.svg?branch=master
       :target: https://codecov.io/github/xray7224/PyPump

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

What is Pump.io?
================

Pump.io is a socially oriented federated network. It provides a way to post notes and images as well and subscribe to other people to get updates on what they post.


What's PyPump?
===============

PyPump provides an interface to the pump.io API's. The aim is to provide very natural pythonic representations of Notes, Images, People, etc... allowing you to painlessly interact with them. 


What does PyPump require?
==========================

PyPump works with:

- Python (2.7, 3.3+)
- requests-oauthlib 0.3.0+
- requests 2.3.0+

*We provide a unified version which works with both the python 2 and python 3 versions.*

Documentation
=============

PyPump is documented. They are currently hosted on Read The Docs:

`latest docs <https://pypump.readthedocs.org/en/latest/>`_

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

You can install it via pip::

    $ pip install pypump

Chat with us?
=============

If you've found an issue please report it on the GitHub issue's https://github.com/xray7224/PyPump/issues

If you just want to chat and let us know the cool things you're doing with PyPump (or want to do) then we have an IRC channel, we currently have our channel on MegNet:

_`MegNet`: https://megworld.co.uk/irc

_`Webchat`: https://webchat.megworld.co.uk/?channels=#pypump


Licence?
========

We're licensed under the GPL version 3 or (at your option) a later version. You can find more information about this licence at https://www.gnu.org/licenses/gpl.html


Want to help out?
==================
Fantastic! Please do, we always need developers, translators (for documentation), testers, etc... Head over to the github and IRC!
