A package to consume Django-Piston web services
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:
- Serializing call arguments and deserializing responses from the api. It can deserialize json provided by Piston into light-weight objects.
- Making the http calls for you. You should be able to call a method on an api object instead of having to fetch a particular URL.
- Provide a in-code description of your API. Developers should be able to know your API by looking at the client code you provide.
You can read the latest docs online.
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:
This will ensure the tests run on Python 2.6, 2.7 and 3.2, and the docs build correctly. Tests pass against Python 3, but oauth tests are skipped as the oauth module still doesn’t have Python 3 support.
Building the docs locally
With sphinx installed, you should be able to build the documentation for this code with:
cd doc make html