Skip to content

(Deprecated - Please check out Django one-to-one Websocket-based Asyncio-handled chat, developed by Bearle team


Notifications You must be signed in to change notification settings


Repository files navigation

🛑 Deprecated 🛑

This project is deprecated. A new and improved version has been released:

Please check it out.

😎 django-private-chat 😎

Please also check out our another package

Django one-to-one Websocket-based Asyncio-handled chat, developed by Bearle team

Important Notes

This app uses separate management command, run_chat_server for running Websockets in Django context. It is intended to be used with something like Supervisor or Systemd to run asyncio webserver as a separate one from Django. We didn't want our app to be limited to be used together with Django Channels - that's why we did it that way.

You can find an example Systemd config to run it as a service at



The full documentation is (finally) at . You can also check the docstrings & this readme.

Example project

You can check out our example project by cloning the repo and heading into example/ directory. There is a README file for you to check, initial data to check out the chat included.

Customize the templates

How to customize the template? Just copy:


And feel free to edit it as you like! We intentionally left the JS code inside for it to be editable easily.

Existing project quickstart

Install django-private-chat:

pip install django-private-chat


python migrate django_private_chat

Note: you can use this package with or without uvloop, just run either

python run_chat_server

or run

python run_chat_server_uvloop

Add it to your INSTALLED_APPS:


Add the server & port for your asyncio server to settings:

CHAT_WS_SERVER_HOST = 'localhost'

It is possible to change messages datetime format using


Add django-private-chat's URL patterns:

from django_private_chat import urls as django_private_chat_urls

urlpatterns = [
    url(r'^', include('django_private_chat.urls')),


{% block extra_js %}{% endblock extra_js %}

to your base template

Now you can start a dialog using


To create a WSS (TLS) server instead:

python run_chat_server "path/to/cert.pem"

(also works with uvloop). The "cert.pem" file should be a plaintext PEM file containing first a private key, then a certificate (may be a concatenation of a .key and a .crt file). Please note that wss will use TLSv1 by default for python 3.5 & 3.4 and will use ssl.PROTOCOL_TLS_SERVER for 3.6 and above. Features --------

-:white_check_mark: Uses current app model (get_user_model() and settings.AUTH_USER_MODEL)

-:white_check_mark: Translatable (uses ugettext and {% trans %} )

-:white_check_mark: One-to-one user chat

-:white_check_mark: Works using WebSockets

-:white_check_mark: Works (optionally) using WSS (TLS) connections (disclaimer - security not guaranteed)

-:white_check_mark: Displays online/offline status

-:white_check_mark: Display typing/not typing status

-:white_check_mark: Soft deletable message model - be sure to keep messages to comply with message-keeping laws

-:white_check_mark: Flash the dialog button when the user you are not currently talking to wrote you a message

-:point_right: TODO: add a dialog to the list when new one started

-:point_right: TODO: add user-not-found and other alerts

-:point_right: possible Redis backend intergration

Running Tests

Does the code actually work?

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox


Tools used in rendering this package: