Metadata-Version: 2.0
Name: rapidpro-python
Version: 2.1.4
Summary: Python client library for the RapidPro
Home-page: https://github.com/rapidpro
Author: Nyaruka
Author-email: code@nyaruka.com
License: BSD
Keywords: rapidpro client
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Requires-Dist: pytz
Requires-Dist: requests
Requires-Dist: six

RapidPro Python Client
======================

|Build Status| |Coverage Status|

Official Python client library for the
`RapidPro <http://rapidpro.github.io/rapidpro/>`__. Supports latest
Python 2 and 3.

Visit `here <http://rapidpro-python.readthedocs.org/>`__ for complete
documentation.

Installation
------------

::

    pip install rapidpro-python

Example
-------

.. code:: python

    from temba_client.v1 import TembaClient
    client = TembaClient('rapidpro.io', 'your-api-token')
    for contact in client.get_contacts():
        print(contact.name)

    client.create_broadcast(text="Howdy", contacts=contacts[0:5])
    client.block_contacts(contacts[1:3])

If you don't know your API token then visit the `API
Explorer <http://rapidpro.io/api/v1/explorer>`__

Development
-----------

For discussions about future development, see the `RapidPro Developers
Group <https://groups.google.com/forum/#!forum/rapidpro-dev>`__.

To run the tests:

::

    nosetests --with-coverage --cover-erase --cover-package=temba_client --cover-html

.. |Build Status| image:: https://travis-ci.org/rapidpro/rapidpro-python.svg?branch=master
.. |Coverage Status| image:: https://coveralls.io/repos/github/rapidpro/rapidpro-python/badge.svg?branch=master
   :target: https://coveralls.io/github/rapidpro/rapidpro-python


