mirror of https://github.com/encode/django-rest-framework.git synced 2024-11-22 09:36:49 +03:00

Web APIs for Django. 🎸

api django python rest starred-encode-repo starred-repo

Go to file

Tom Christie 4b2139c91a Merge pull request #344 from minddust/master minor docs fix		2012-10-31 02:45:23 -07:00
docs	Merge pull request #344 from minddust/master	2012-10-31 02:45:23 -07:00
rest_framework	Final docs tweaks for 2.0	2012-10-30 13:59:31 +00:00
.gitignore	Change package name: djangorestframework -> rest_framework	2012-09-20 13:06:27 +01:00
.travis.yml	Add PYTHONPATH in travis config	2012-10-11 13:12:43 +01:00
MANIFEST.in	Remove old 'djangorestframework directories	2012-09-20 13:19:43 +01:00
mkdocs.py	Package and doc tweaks	2012-10-30 14:48:48 +00:00
optionals.txt	Cleaner documentation around installation of optional packages	2012-09-03 12:11:57 +01:00
README.md	Docs to django-rest-framework.org	2012-10-30 14:41:44 +00:00
requirements.txt	Remove old 'djangorestframework directories	2012-09-20 13:19:43 +01:00
setup.py	Package and doc tweaks	2012-10-30 14:48:48 +00:00
tox.ini	Fix serialization issue with Django 1.3	2012-09-28 14:53:22 +01:00

README.md

Django REST framework

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

Author: Tom Christie. Follow me on Twitter

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

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

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

2.0.0

Redesign of core components.
Fix all of the things.

License

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.