Developer-friendly asynchrony for Django
.. 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
Support can be obtained through several locations - see our
support docs_ for more.
You can install channels from PyPI as the
channelspackage. See our
tutorial_ docs for more.
All Channels projects currently support Python 3.6 and up.
channelsis compatible with Django 2.2, 3.0, 3.1 and 3.2.
To learn more about contributing, please
read our contributing docs_.
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_ and get in touch!
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