django-rest-framework/README.md

119 lines
4.6 KiB
Markdown
Raw Normal View History

2012-08-29 23:57:37 +04:00
# Django REST framework
**A toolkit for building well-connected, self-describing web APIs.**
2012-12-18 02:00:25 +04:00
**Author:** Tom Christie. [Follow me on Twitter][twitter].
2013-02-13 02:05:28 +04:00
**Support:** [REST framework group][group], or `#restframework` on freenode IRC.
2012-08-29 23:57:37 +04:00
2012-09-28 13:11:29 +04:00
[![build-status-image]][travis]
2012-10-30 16:23:17 +04:00
---
**Full documentation for REST framework is available on [http://django-rest-framework.org][docs].**
---
2012-08-29 23:57:37 +04:00
# Overview
2012-10-30 16:23:17 +04:00
Django REST framework is a lightweight library that makes it easy to build Web APIs. It is designed as a modular and easy to customize architecture, based on Django's class based views.
Web APIs built using REST framework are fully self-describing and web browseable - a huge useability win for your developers. It also supports a wide range of media types, authentication and permission policies out of the box.
2012-08-29 23:57:37 +04:00
2012-10-30 16:23:17 +04:00
If you are considering using REST framework for your API, we recommend reading the [REST framework 2 announcment][rest-framework-2-announcement] which gives a good overview of the framework and it's capabilities.
There is also a sandbox API you can use for testing purposes, [available here][sandbox].
2012-08-29 23:57:37 +04:00
# Requirements
2013-02-01 19:07:51 +04:00
* Python (2.6, 2.7, 3.2, 3.3)
2012-08-29 23:57:37 +04:00
* Django (1.3, 1.4, 1.5)
**Optional:**
* [Markdown] - Markdown support for the self describing API.
* [PyYAML] - YAML content type support.
2012-11-13 16:20:03 +04:00
* [django-filter] - Filtering support.
2012-08-29 23:57:37 +04:00
# Installation
Install using `pip`, including any optional packages you want...
2012-08-29 23:57:37 +04:00
pip install djangorestframework
pip install markdown # Markdown support for the browseable API.
pip install pyyaml # YAML content-type support.
pip install django-filter # Filtering support
2012-08-29 23:57:37 +04:00
...or clone the project from github.
git clone git@github.com:tomchristie/django-rest-framework.git
cd django-rest-framework
2012-08-29 23:57:37 +04:00
pip install -r requirements.txt
pip install -r optionals.txt
Add `'rest_framework'` to your `INSTALLED_APPS` setting.
INSTALLED_APPS = (
...
'rest_framework',
)
If you're intending to use the browseable API you'll probably also want to add REST framework's login and logout views. Add the following to your root `urls.py` file.
urlpatterns = patterns('',
...
url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework'))
)
Note that the URL path can be whatever you want, but you must include `'rest_framework.urls'` with the `'rest_framework'` namespace.
2012-08-29 23:57:37 +04:00
2012-09-02 00:35:30 +04:00
# Development
To build the docs.
./mkdocs.py
To run the tests.
./rest_framework/runtests/runtests.py
2012-09-02 00:35:30 +04:00
2012-08-29 23:57:37 +04:00
# License
2013-01-04 01:43:54 +04:00
Copyright (c) 2011-2013, Tom Christie
2011-03-09 11:18:06 +03:00
All rights reserved.
2011-12-16 14:06:02 +04:00
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
2011-03-09 11:18:06 +03:00
2011-12-16 14:06:02 +04:00
Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.
2011-03-09 11:18:06 +03:00
2011-12-16 14:06:02 +04:00
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
2012-08-29 23:57:37 +04:00
2013-01-04 01:43:54 +04:00
[build-status-image]: https://secure.travis-ci.org/tomchristie/django-rest-framework.png?branch=master
2012-10-30 18:37:07 +04:00
[travis]: http://travis-ci.org/tomchristie/django-rest-framework?branch=master
2012-08-29 23:57:37 +04:00
[twitter]: https://twitter.com/_tomchristie
2012-12-18 02:00:25 +04:00
[group]: https://groups.google.com/forum/?fromgroups#!forum/django-rest-framework
2012-10-30 16:23:17 +04:00
[0.4]: https://github.com/tomchristie/django-rest-framework/tree/0.4.X
[sandbox]: http://restframework.herokuapp.com/
2012-11-15 02:24:18 +04:00
[rest-framework-2-announcement]: http://django-rest-framework.org/topics/rest-framework-2-announcement.html
[2.1.0-notes]: https://groups.google.com/d/topic/django-rest-framework/Vv2M0CMY9bg/discussion
2012-10-30 16:23:17 +04:00
2012-10-30 18:41:44 +04:00
[docs]: http://django-rest-framework.org/
2012-08-29 23:57:37 +04:00
[urlobject]: https://github.com/zacharyvoase/urlobject
[markdown]: http://pypi.python.org/pypi/Markdown/
[pyyaml]: http://pypi.python.org/pypi/PyYAML
2013-01-12 17:28:16 +04:00
[django-filter]: http://pypi.python.org/pypi/django-filter