Django Channels

.. image:: https://github.com/django/channels/workflows/Tests/badge.svg?branch=master :target: https://github.com/django/channels/actions

.. 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 augments Django to bring WebSocket, long-poll HTTP, task offloading and other async 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.

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

Channels is an official Django Project and as such has a deprecation policy. Details about what's deprecated or pending deprecation for each release is in the

release notes 

Support can be obtained through several locations - see our

support docs 

You can install channels from PyPI as the

channels

installation 

tutorial 

Dependencies

All Channels projects currently support Python 3.6 and up.

channels

Contributing

To learn more about contributing, please

read our contributing docs 

Maintenance and Security

To report security issues, please contact [email protected] 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 

Maintenance is overseen by Carlton Gibson with help from others. It is a best-effort basis - we unfortunately can only dedicate guaranteed time to fixing security holes.

If you are interested in joining the maintenance team, please

read more about contributing 

Other Projects

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

• Daphne 

  _, the HTTP and Websocket termination server

• channels_redis 

  _, the Redis channel backend

• asgiref 

  _, the base ASGI library/memory backend