Django REST framework makes it easy to build well-connected, self-describing RESTful Web APIs.
Python
Pull request Compare This branch is 6057 commits behind tomchristie:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
djangorestframework
docs
examples
.gitignore
.travis.yml
AUTHORS
CHANGELOG.rst
LICENSE
MANIFEST.in
README.rst
requirements.txt
setup.py
tox.ini

README.rst

Django REST framework

Django REST framework makes it easy to build well-connected, self-describing RESTful Web APIs.

Author: Tom Christie. Follow me on Twitter.

build status:build-image

Overview

Features:

  • Creates awesome self-describing web browse-able APIs.
  • Clean, modular design, using Django's class based views.
  • Easily extended for custom content types, serialization formats and authentication policies.
  • Stable, well tested code-base.
  • Active developer community.

Full documentation for the project is available at http://django-rest-framework.org

Issue tracking is on GitHub. General questions should be taken to the discussion group.

Requirements:

  • Python 2.6+
  • Django 1.3+

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
virtualenv --no-site-packages --distribute env
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