Web APIs for Django. 🎸
Go to file
Marko Tibold af7214f86a whoops.
2012-08-23 23:16:51 +02:00
djangorestframework Merge pull request #181 from flashingpumpkin/master 2012-08-23 04:15:41 -07:00
docs Fix typo. 2012-04-12 01:06:35 +03:00
examples Include examples tests. 2012-08-23 23:14:37 +02:00
.gitignore Commit to trigger Travis-ci. 2012-08-23 22:04:25 +02:00
.travis.yml whoops. 2012-08-23 23:16:51 +02:00
AUTHORS Added @pilt - Thanks! 2012-08-21 17:39:40 +02:00
CHANGELOG.rst Use seuptools to be explicit about optional version-dependency of markdown. 2012-04-11 23:51:00 +02:00
LICENSE Fold license text to 80 chars 2011-12-16 10:06:12 +00:00
MANIFEST.in Fix up packaging and staticfiles changes. Fixes #155. Fixes #153. Fixes #150. 2012-02-07 08:58:15 +00:00
README.rst 1.4 Ain't alpha. 2012-05-11 09:46:00 +02:00
requirements.txt Preserve existing query params in PaginatorMixin 2012-01-05 14:07:31 +00:00
setup.py Use seuptools to be explicit about optional version-dependency of markdown. 2012-04-11 23:51:00 +02:00

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 <https://twitter.com/_tomchristie>`_.

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 <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>`_.

We also have a `Jenkins service <http://jenkins.tibold.nl/job/djangorestframework1/>`_ which runs our test suite. 

Requirements:

* Python (2.5, 2.6, 2.7 supported)
* Django (1.2, 1.3, 1.4 supported)


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