django-private-chat 0.1.1

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

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

Documentation

The full documentation is at https://django-private-chat.readthedocs.io.

Quickstart

Install django-private-chat:

pip install django-private-chat

Migrate:

python manage.py migrate django-private-chat

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

python manage.py run_chat_server

or run

python manage.py run_chat_server_uvloop

Add it to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'django_private_chat.apps.DjangoPrivateChatConfig',
    ...
)

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

CHAT_WS_SERVER_HOST = 'localhost'
CHAT_WS_SERVER_PORT = 5002

It is possible to change messages datetime format using

DATETIME_FORMAT

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)),
    ...
]

Now you can start a dialog using

/dialogs/some_existing_username

Features

• Uses current app model (get_user_model() and settings.AUTH_USER_MODEL)

• Translatable (uses ugettext and {% trans %} )

• One-to-one user chat

• Works using WebSockets

• Displays online/offline status

• Display typing/not typing status

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

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

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

• TODO: possible Redis backend intergration

Running Tests

Does the code actually work?

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

Credits

Tools used in rendering this package:

• Cookiecutter

• cookiecutter-djangopackage

History

0.1.1 (2017-02-10)

• Added migrations.

0.1.0 (2017-02-10)

• First release on PyPI.