django-rest-framework/docs/howto/setup.rst

54 lines
1.9 KiB
ReStructuredText
Raw Normal View History

2011-02-19 16:12:35 +03:00
.. _setup:
Setup
=====
2011-06-02 16:34:23 +04:00
Installing into site-packages
-----------------------------
If you need to manually install Django REST framework to your ``site-packages`` directory, run the ``setup.py`` script::
python setup.py install
2011-02-19 16:12:35 +03:00
Template Loaders
----------------
2012-01-03 00:16:44 +04:00
Django REST framework uses a few templates for the HTML and plain text documenting renderers.
2011-02-19 16:12:35 +03:00
* Ensure ``TEMPLATE_LOADERS`` setting contains ``'django.template.loaders.app_directories.Loader'``.
This will be the case by default so you shouldn't normally need to do anything here.
Admin Styling
-------------
2012-01-03 00:16:44 +04:00
Django REST framework uses the admin media for styling. When running using Django's testserver this is automatically served for you,
but once you move onto a production server, you'll want to make sure you serve the admin media separately, exactly as you would do
`if using the Django admin <https://docs.djangoproject.com/en/dev/howto/deployment/modpython/#serving-the-admin-files>`_.
2011-02-19 16:12:35 +03:00
2012-01-03 00:16:44 +04:00
* Ensure that the ``ADMIN_MEDIA_PREFIX`` is set appropriately and that you are serving the admin media.
(Django's testserver will automatically serve the admin media for you)
2011-02-19 16:12:35 +03:00
Markdown
--------
The Python `markdown library <http://www.freewisdom.org/projects/python-markdown/>`_ is not required but comes recommended.
2012-01-03 00:16:44 +04:00
If markdown is installed your :class:`.Resource` descriptions can include `markdown style formatting
<http://daringfireball.net/projects/markdown/syntax>`_ which will be rendered by the HTML documenting renderer.
2011-02-19 16:12:35 +03:00
login/logout
---------------------------------
Django REST framework comes with a few views that can be useful including an api
login and logout views::
from django.conf.urls.defaults import patterns
urlpatterns = patterns('djangorestframework.views',
# Add your resources here
(r'^accounts/login/$', 'api_login'),
(r'^accounts/logout/$', 'api_logout'),
)