Overview
========

Piston mini client is a package that allows you to easily describe an
API provided by a Django server using django-piston that takes care of:

You can read the `latest docs online`_.

.. _latest docs online: http://packages.python.org/piston-mini-client/


Installation
============
piston-mini-client uses a standard distutils setup.py script, so you can use::

  python setup.py install

Running the tests
=================
To run the tests, just install tox_ (can be in a virtualenv) and then run::

  tox

This will ensure the tests run on Python 2.6 and 2.7, and the docs build
correctly.  There is basic Python 3 support, but it isn't covered by tox yet.

Building the docs locally
=========================
With sphinx_ installed, you should be able to build the documentation for
this code with::

  cd doc
  make html

Enjoy!


.. _tox: http://pypi.python.org/pypi/tox
.. _sphinx: http://sphinx.pocoo.org/
