django-rest-framework/README.rst

87 lines
2.3 KiB
ReStructuredText
Raw Normal View History

2011-07-01 18:55:33 +04:00
Django REST framework
=====================
2012-02-07 13:29:48 +04:00
**Django REST framework makes it easy to build well-connected, self-describing RESTful Web APIs.**
2012-02-07 13:30:08 +04:00
2012-02-07 13:31:08 +04:00
**Author:** Tom Christie. `Follow me on Twitter <https://twitter.com/_tomchristie>`_.
2012-02-07 13:29:48 +04:00
2012-08-26 02:40:36 +04:00
:build status: |build-image|
2012-08-26 02:43:35 +04:00
.. |build-image| image:: https://secure.travis-ci.org/tomchristie/django-rest-framework.png?branch=master
:target: https://secure.travis-ci.org/tomchristie/django-rest-framework
2012-08-26 02:33:17 +04:00
2012-02-07 13:29:48 +04:00
Overview
========
2011-07-01 18:55:33 +04:00
2011-07-01 19:24:32 +04:00
Features:
* Creates awesome self-describing *web browse-able* APIs.
* Clean, modular design, using Django's class based views.
2011-12-12 16:27:04 +04:00
* Easily extended for custom content types, serialization formats and authentication policies.
2011-07-01 19:24:32 +04:00
* Stable, well tested code-base.
* Active developer community.
2011-07-01 18:55:33 +04:00
Full documentation for the project is available at http://django-rest-framework.org
Issue tracking is on `GitHub <https://github.com/tomchristie/django-rest-framework/issues>`_.
General questions should be taken to the `discussion group <http://groups.google.com/group/django-rest-framework>`_.
2011-07-01 19:24:32 +04:00
Requirements:
* Python 2.6+
* Django 1.3+
2011-07-01 18:55:33 +04:00
Installation Notes
==================
To clone the project from GitHub using git::
git clone git@github.com:tomchristie/django-rest-framework.git
To install django-rest-framework in a virtualenv environment::
cd django-rest-framework
2011-12-30 17:06:57 +04:00
virtualenv --no-site-packages --distribute env
2011-07-01 18:55:33 +04:00
source env/bin/activate
pip install -r requirements.txt # django, coverage
To run the tests::
export PYTHONPATH=. # Ensure djangorestframework is on the PYTHONPATH
python djangorestframework/runtests/runtests.py
To run the test coverage report::
export PYTHONPATH=. # Ensure djangorestframework is on the PYTHONPATH
python djangorestframework/runtests/runcoverage.py
To run the examples::
pip install -r examples/requirements.txt # pygments, httplib2, markdown
cd examples
export PYTHONPATH=..
python manage.py syncdb
python manage.py runserver
To build the documentation::
pip install -r docs/requirements.txt # sphinx
sphinx-build -c docs -b html -d docs/build docs html
To run the tests against the full set of supported configurations::
deactivate # Ensure we are not currently running in a virtualenv
tox
To create the sdist packages::
python setup.py sdist --formats=gztar,zip