daphne/docs/installation.rst
2015-09-10 11:04:16 -06:00

35 lines
1016 B
ReStructuredText
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Installation
============
Channels is available on PyPI - to install it, just run::
pip install -U channels
Once that's done, you should add ``channels`` to your
``INSTALLED_APPS`` setting::
INSTALLED_APPS = (
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.sites',
...
'channels',
)
That's it! Once enabled, ``channels`` will integrate itself into Django and
take control of the ``runserver`` command. See :doc:`getting-started` for more.
Installing the lastest development version
------------------------------------------
To install the latest version of Channels, clone the repo, change to the repo,
change to the repo directory, and pip install it into your current virtual
environment::
$ git clone git@github.com:andrewgodwin/channels.git
$ cd channels
$ <activate your projects virtual environment>
(environment) $ pip install -e . # the dot specifies the current repo