encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2024-11-22 09:36:49 +03:00
Code Issues Packages Projects Releases Wiki Activity

Cleaner documentation around installation of optional packages

Browse Source
This commit is contained in:
Tom Christie 2012-09-03 12:11:57 +01:00
parent 0ef6b1c122
commit ddc8c30317
2 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/index.md
View File

@ -19,20 +19,24 @@ REST framework requires the following:
The following packages are optional: The following packages are optional:
* [Markdown][markdown] (2.1.0+) - Markdown support for the self describing API. * [Markdown][markdown] (2.1.0+) - Markdown support for the self describing API.
* [PyYAML][yaml] (3.10+) - YAML content type support. * [PyYAML][yaml] (3.10+) - YAML content-type support.
## Installation ## Installation
**WARNING: These instructions will only become valid once this becomes the master version** **WARNING: These instructions will only become valid once this becomes the master version**
Install using `pip`... Install using `pip`, including any optional packages you want...
pip install djangorestframework pip install djangorestframework
pip install markdown # Recommended if using the browseable API.
pip install pyyaml # Required for yaml content-type support.
...or clone the project from github. ...or clone the project from github.
git clone git@github.com:tomchristie/django-rest-framework.git git clone git@github.com:tomchristie/django-rest-framework.git
cd django-rest-framework
pip install -r requirements.txt pip install -r requirements.txt
pip install -r optionals.txt
Add `djangorestframework` to your `INSTALLED_APPS`. Add `djangorestframework` to your `INSTALLED_APPS`.

2
optionals.txt Normal file
View File

@ -0,0 +1,2 @@
markdown>=2.1.0
PyYAML>=3.10