mirror of
https://github.com/encode/django-rest-framework.git
synced 2024-09-21 11:29:01 +03:00
84 lines
2.3 KiB
ReStructuredText
84 lines
2.3 KiB
ReStructuredText
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
|