Django Channels HTTP/WebSocket server
Go to file
Bartek Ogryczak ee4aa9b292 more consistent metrics (#473)
* more consistent metrics

More consistent metrics, in particular for consumers such as Graphite, CloudWatch etc. you don't want aggregated numbers per second, you want number since previous call. Since we don't want to track all the clients, total since start is the next best thing, because it can be easily calculated by the metrics consumer `count_since_last = pervious_count - current_count`

* changing 'queue_depth' to 'messages_pending', also making 'messages' plurar for 'max_age' to keep it consitent
2017-01-11 11:49:59 -08:00
.github Redirecting questions to the mailing list 2016-11-04 17:24:21 +01:00
channels Remove unicode literals (#476) 2017-01-11 10:03:03 -08:00
docs more consistent metrics (#473) 2017-01-11 11:49:59 -08:00
loadtesting Fix URLs of load testing graphs (#459) 2017-01-05 07:53:45 -08:00
testproject Correct spelling mistakes (#464) 2017-01-08 13:22:50 -08:00
.coveragerc Test runserver (#214) 2016-06-29 11:26:21 -07:00
.gitignore Initial implementation of the contribution file 2016-07-21 12:21:12 -04:00
.travis.yml Add Python 3.4 to Travis config. 2016-03-12 15:35:55 -08:00
CHANGELOG.txt Use HTTPS in changelog (#472) 2017-01-10 10:05:23 -08:00
CONTRIBUTING.rst Convert readthedocs link for their .org -> .io migration for hosted projects (#374) 2016-09-22 14:17:39 -07:00
LICENSE Add some kind of license 2015-07-13 23:41:19 -07:00
Makefile Add release makefile 2016-06-22 10:05:57 -07:00
patchinator.py Convert readthedocs link for their .org -> .io migration for hosted projects (#374) 2016-09-22 14:17:39 -07:00
README.rst Convert readthedocs link for their .org -> .io migration for hosted projects (#374) 2016-09-22 14:17:39 -07:00
runtests.py Add tox and run tests for python 2.7/3.5 and Django 1.6-1.8 2015-11-09 12:58:59 +01:00
setup.cfg Sort imports and make Travis run isort (#425) 2016-11-05 12:08:38 +01:00
setup.py build endpoint description strings from runserver arguments before ca… (#434) 2017-01-08 18:10:56 -08:00
tox.ini Sort imports and make Travis run isort (#425) 2016-11-05 12:08:38 +01:00

Django Channels
===============

.. image:: https://api.travis-ci.org/django/channels.svg
    :target: https://travis-ci.org/django/channels

.. image:: https://readthedocs.org/projects/channels/badge/?version=latest
    :target: https://channels.readthedocs.io/en/latest/?badge=latest

.. image:: https://img.shields.io/pypi/v/channels.svg
    :target: https://pypi.python.org/pypi/channels

.. image:: https://img.shields.io/pypi/l/channels.svg
    :target: https://pypi.python.org/pypi/channels

Channels loads into Django as a pluggable app to bring WebSocket, long-poll HTTP,
task offloading and other asynchrony support to your code, using familiar Django
design patterns and a flexible underlying framework that lets you not only
customize behaviours but also write support for your own protocols and needs.

This is still **beta** software: the API is mostly settled, but might change
a bit as things develop. Once we hit ``1.0``, it will be stablized and a
deprecation policy will come in.

Documentation, installation and getting started instructions are at
https://channels.readthedocs.io

Support can be obtained either here via issues, or in the ``#django-channels``
channel on Freenode.

You can install channels from PyPI as the ``channels`` package.
You'll likely also want to ``asgi_redis`` to provide the Redis channel layer.
See our `installation <https://channels.readthedocs.io/en/latest/installation.html>`_
and `getting started <https://channels.readthedocs.io/en/latest/getting-started.html>`_ docs for more.


Contributing
------------

To learn more about contributing, please `read our contributing docs <https://channels.readthedocs.io/en/latest/contributing.html>`_.


Maintenance and Security
------------------------

To report security issues, please contact security@djangoproject.com. For GPG
signatures and more security process information, see
https://docs.djangoproject.com/en/dev/internals/security/.

To report bugs or request new features, please open a new GitHub issue. For
larger discussions, please post to the
`django-developers mailing list <https://groups.google.com/d/forum/django-developers>`_.

Django Core Shepherd: Andrew Godwin <andrew@aeracode.org>

Maintenance team:

* Andrew Godwin <andrew@aeracode.org>
* Steven Davidson
* Jeremy Spencer

If you are interested in joining the maintenance team, please
`read more about contributing <https://channels.readthedocs.io/en/latest/contributing.html>`_
and get in touch!


Other Projects
--------------

The Channels project is made up of several packages; the others are:

* `Daphne <https://github.com/django/daphne/>`_, the HTTP and Websocket termination server
* `asgiref <https://github.com/django/asgiref/>`_, the base ASGI library/memory backend
* `asgi_redis <https://github.com/django/asgi_redis/>`_, the Redis channel backend
* `asgi_ipc <https://github.com/django/asgi_ipc/>`_, the POSIX IPC channel backend