encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2024-11-27 12:04:02 +03:00
Code Issues Packages Projects Releases Wiki Activity
Web APIs for Django. 🎸
749 Commits 18 Branches 132 Tags 105 MiB
Python 83.5%
JavaScript 9.6%
HTML 4.7%
CSS 2.2%
f741bab709
Go to file
Tom Christie f741bab709 Added @phobologic. Thanks\!
2012-09-19 17:05:09 +01:00
djangorestframework Fixing Issue #265. 2012-09-19 08:05:16 -07:00
docs Add trailing slash to auth url. Refs: #248 2012-09-05 10:04:45 +01:00
examples Fix broken link 2012-09-01 23:04:14 +01:00
.gitignore Travis CI 2012-08-25 20:07:53 +01:00
.travis.yml Drop examples tests from travis to keep number of configurations sane 2012-08-25 22:24:24 +01:00
AUTHORS Added @phobologic. Thanks\! 2012-09-19 17:05:09 +01:00
CHANGELOG.rst Release notes for 0.4.0 2012-08-29 21:39:12 +01: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 Drop link to Jenkins 2012-09-02 09:30:20 +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
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>`_.

:build status: |build-image|

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

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

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