encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2024-09-21 03:19:00 +03:00
Code Issues Packages Projects Releases Wiki Activity
Web APIs for Django. 🎸
690 Commits 18 Branches 132 Tags 120 MiB
Python 83.5%
JavaScript 9.6%
HTML 4.7%
CSS 2.2%
55317b0372
Go to file
Marko Tibold 55317b0372 Fixes broken permissions-example. 
reverse takes `request` as a kwarg.
2012-02-29 21:32:10 +01:00
djangorestframework Fix for #178. 2012-02-23 16:30:44 -08:00
docs Update docs/requirements.txt 2012-02-27 10:06:20 +00:00
examples Fixes broken permissions-example. 2012-02-29 21:32:10 +01:00
.gitignore 0.2.4 release. 2011-12-12 12:27:11 +00:00
AUTHORS Added @shawnlewis. Thanks! 2012-02-24 13:13:11 +00:00
CHANGELOG.rst Version 0.3.3 2012-02-20 20:33:07 +00: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 Tweak 2012-02-07 09:31:08 +00:00
requirements.txt Preserve existing query params in PaginatorMixin 2012-01-05 14:07:31 +00:00
setup.py Attempt to stop banging head against brick wall. 2012-02-07 10:14:34 +00:00
tox.ini django-staticfiles for Django 1.2 compatability 2012-01-31 09:05:52 +00:00

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 <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-alpha 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