django-rest-framework/README.md

# Django REST framework

**A toolkit for building well-connected, self-describing web APIs.**

**Author:** Tom Christie.  [Follow me on Twitter][twitter]

[![build-status-image]][travis]

---

**Full documentation for REST framework is available on [http://django-rest-framework.org][docs].**

Note that this is the 2.0 version of REST framework.  If you are looking for earlier versions please see the [0.4.x branch][0.4] on GitHub.

---

# Overview

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.

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

# Requirements

* Python (2.6, 2.7)
* Django (1.3, 1.4, 1.5)

**Optional:**

* [Markdown] - Markdown support for the self describing API.
* [PyYAML] - YAML content type support.

# Installation

Install using `pip`...

    pip install djangorestframework

...or clone the project from github.

    git clone git@github.com:tomchristie/django-rest-framework.git
    pip install -r requirements.txt

# Development

To build the docs.

    ./mkdocs.py

To run the tests.

    ./rest_framework/runtests/runtests.py

# Changelog

## Master

* Minor field improvements (don't stringify dicts, more robust many-pk fields)

## 2.0.2

**Date**: 2nd Nov 2012

* Fix issues with pk related fields in the browsable API.

## 2.0.1

**Date**: 1st Nov 2012

* Add support for relational fields in the browsable API.
* Added SlugRelatedField and ManySlugRelatedField.
* If PUT creates an instance return '201 Created', instead of '200 OK'.

## 2.0.0

**Date**: 30th Oct 2012

* Redesign of core components.
* Fix **all of the things**.

# License

Copyright (c) 2011, Tom Christie
All rights reserved.

Redistribution and use in source and binary forms, with or without 
modification, are permitted provided that the following conditions are met:

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.

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.

[build-status-image]: https://secure.travis-ci.org/tomchristie/django-rest-framework.png?branch=restframework2
[travis]: http://travis-ci.org/tomchristie/django-rest-framework?branch=master
[twitter]: https://twitter.com/_tomchristie
[0.4]: https://github.com/tomchristie/django-rest-framework/tree/0.4.X
[sandbox]: http://restframework.herokuapp.com/
[rest-framework-2-announcement]: topics/rest-framework-2-announcement.md

[docs]: http://django-rest-framework.org/
[urlobject]: https://github.com/zacharyvoase/urlobject
[markdown]: http://pypi.python.org/pypi/Markdown/
[pyyaml]: http://pypi.python.org/pypi/PyYAML
New docs 2012-08-29 23:57:37 +04:00			`# Django REST framework`

			`A toolkit for building well-connected, self-describing web APIs.`

			`Author: Tom Christie. [Follow me on Twitter][twitter]`

More simple travis link style 2012-09-28 13:11:29 +04:00			`[![build-status-image]][travis]`
Collapsing menu, travis and github badges, horizontal scrolling code on overflow 2012-09-09 19:56:04 +04:00
Docs update 2012-10-30 16:23:17 +04:00			`---`

			`Full documentation for REST framework is available on [http://django-rest-framework.org][docs].`

			`Note that this is the 2.0 version of REST framework. If you are looking for earlier versions please see the [0.4.x branch][0.4] on GitHub.`

			`---`

New docs 2012-08-29 23:57:37 +04:00			`# Overview`

Docs update 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.`
New docs 2012-08-29 23:57:37 +04:00
Docs update 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].`
New docs 2012-08-29 23:57:37 +04:00
			`# Requirements`

			`* Python (2.6, 2.7)`
			`* Django (1.3, 1.4, 1.5)`

			`Optional:`

			`* [Markdown] - Markdown support for the self describing API.`
			`* [PyYAML] - YAML content type support.`

			`# Installation`

			Install using `pip`...

Fix PyPI package name in install instructions 2012-10-26 22:55:23 +04:00			`pip install djangorestframework`
New docs 2012-08-29 23:57:37 +04:00
			`...or clone the project from github.`

			`git clone git@github.com:tomchristie/django-rest-framework.git`
			`pip install -r requirements.txt`

Docs tweak for first docs deployment 2012-09-02 00:35:30 +04:00			`# Development`

			`To build the docs.`

			`./mkdocs.py`

			`To run the tests.`

Change package name: djangorestframework -> rest_framework 2012-09-20 16:06:27 +04:00			`./rest_framework/runtests/runtests.py`
Docs tweak for first docs deployment 2012-09-02 00:35:30 +04:00
New docs 2012-08-29 23:57:37 +04:00			`# Changelog`

Update release notes 2012-11-03 01:13:29 +04:00			`## Master`

			`* Minor field improvements (don't stringify dicts, more robust many-pk fields)`

Fix issues with pk related fields in the browsable API. 2012-11-02 18:05:14 +04:00			`## 2.0.2`

			`Date: 2nd Nov 2012`

			`* Fix issues with pk related fields in the browsable API.`

			`## 2.0.1`

			`Date: 1st Nov 2012`

			`* Add support for relational fields in the browsable API.`
			`* Added SlugRelatedField and ManySlugRelatedField.`
			`* If PUT creates an instance return '201 Created', instead of '200 OK'.`

New docs 2012-08-29 23:57:37 +04:00			`## 2.0.0`

Fix issues with pk related fields in the browsable API. 2012-11-02 18:05:14 +04:00			`Date: 30th Oct 2012`

Rename HTMLTemplateRenderer -> HTMLRenderer, DocuemntingHTMLRenderer -> BrowseableAPIRenderer 2012-10-09 18:58:48 +04:00			`* Redesign of core components.`
			`* Fix all of the things.`
New docs 2012-08-29 23:57:37 +04:00
			`# License`

IANAL 2011-03-09 11:18:06 +03:00			`Copyright (c) 2011, Tom Christie`
			`All rights reserved.`

Fold license text to 80 chars 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:`
IANAL 2011-03-09 11:18:06 +03:00
Fold license text to 80 chars 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.`
IANAL 2011-03-09 11:18:06 +03:00
Fold license text to 80 chars 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.`
New docs 2012-08-29 23:57:37 +04:00
More simple travis link style 2012-09-28 13:11:29 +04:00			`[build-status-image]: https://secure.travis-ci.org/tomchristie/django-rest-framework.png?branch=restframework2`
Update travis image to master 2012-10-30 18:37:07 +04:00			`[travis]: http://travis-ci.org/tomchristie/django-rest-framework?branch=master`
New docs 2012-08-29 23:57:37 +04:00			`[twitter]: https://twitter.com/_tomchristie`
Docs update 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/`
			`[rest-framework-2-announcement]: topics/rest-framework-2-announcement.md`

Docs to django-rest-framework.org 2012-10-30 18:41:44 +04:00			`[docs]: http://django-rest-framework.org/`
New docs 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`