https://github.com/django/channels

Developer-friendly asynchrony for Django
https://github.com/django/channels

Last synced: 3 days ago
JSON representation

Developer-friendly asynchrony for Django

• Host: GitHub
• URL: https://github.com/django/channels
• Owner: django
• License: bsd-3-clause
• Created: 2015-06-03T17:16:20.000Z (over 9 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T02:16:30.000Z (about 1 month ago)
• Last Synced: 2024-10-29T19:58:22.198Z (about 1 month ago)
• Language: Python
• Homepage: https://channels.readthedocs.io
• Size: 2.05 MB
• Stars: 6,092
• Watchers: 159
• Forks: 801
• Open Issues: 97
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.txt
  • Contributing: CONTRIBUTING.rst
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Security: .github/SECURITY.md
  • Support: docs/support.rst

Awesome Lists containing this project

• awesomeLibrary - channels - Developer-friendly asynchrony for Django (语言资源库 / python)
• best-django-resource - Channels - Asynchronous support for Django to handle WebSockets and background tasks. (Essentials)
• my-awesome-starred - django/channels - Developer-friendly asynchrony for Django (Python)
• starred-awesome - channels - Developer-friendly asynchrony for Django (Python)
• StarryDivineSky - django/channels
• best-of-web-python - GitHub - 8% open · ⏱️ 13.05.2024): (Django Utilities)

README

        
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 `_ for more.

You can install channels from PyPI as the ``channels`` package.

See our `installation `_

and `tutorial `_ docs for more.

Dependencies

------------

All Channels projects currently support Python 3.8 and up. ``channels`` is

compatible with Django 4.2 and 5.0.

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 `_

and get in touch!

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