{"id":15060953,"url":"https://github.com/bearle/django_private_chat2","last_synced_at":"2025-04-04T19:12:04.566Z","repository":{"id":37750507,"uuid":"344952421","full_name":"Bearle/django_private_chat2","owner":"Bearle","description":"Chat app for Django, powered by Django Channels, Websockets \u0026 Asyncio","archived":false,"fork":false,"pushed_at":"2023-08-17T07:13:39.000Z","size":3474,"stargazers_count":284,"open_issues_count":21,"forks_count":79,"subscribers_count":10,"default_branch":"master","last_synced_at":"2024-04-14T06:22:16.021Z","etag":null,"topics":["asyncio","channels","chat","chatapplication","dialogs","django","django-channels","frontend","fsharp","python3","react","reactjs","websocket","websocket-chat","websockets"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Bearle.png","metadata":{"files":{"readme":"README.md","changelog":"HISTORY.rst","contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS.rst","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-03-05T22:41:43.000Z","updated_at":"2024-06-19T11:29:13.977Z","dependencies_parsed_at":"2024-06-19T11:28:53.527Z","dependency_job_id":"155c1e4b-db2b-4789-a949-9f3a35a44b62","html_url":"https://github.com/Bearle/django_private_chat2","commit_stats":{"total_commits":140,"total_committers":2,"mean_commits":70.0,"dds":"0.0071428571428571175","last_synced_commit":"a43f1ebd43f96ff1057f182b30b6dbe923d77927"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bearle%2Fdjango_private_chat2","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bearle%2Fdjango_private_chat2/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bearle%2Fdjango_private_chat2/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bearle%2Fdjango_private_chat2/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Bearle","download_url":"https://codeload.github.com/Bearle/django_private_chat2/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247234923,"owners_count":20905854,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["asyncio","channels","chat","chatapplication","dialogs","django","django-channels","frontend","fsharp","python3","react","reactjs","websocket","websocket-chat","websockets"],"created_at":"2024-09-24T23:07:18.582Z","updated_at":"2025-04-04T19:12:04.533Z","avatar_url":"https://github.com/Bearle.png","language":"Python","readme":"Django Private Chat2\n======================\n\n![https://badge.fury.io/py/django_private_chat2](https://badge.fury.io/py/django_private_chat2.svg)\n\n![https://github.com/Bearle/django_private_chat2/actions](https://github.com/Bearle/django_private_chat2/actions/workflows/test.yml/badge.svg?branch=master)\n\n![https://codecov.io/gh/Bearle/django_private_chat2](https://codecov.io/gh/Bearle/django_private_chat2/branch/master/graph/badge.svg)\n\nNew and improved  https://github.com/Bearle/django-private-chat\n\nChat app for Django, powered by Django Channels, Websockets \u0026 Asyncio\n\n![screenshot](https://github.com/Bearle/django_private_chat2/blob/master/screenshots/screen.jpg?raw=true)\n\nDocumentation\n-------------\n\nThe full documentation **will be** at \u003chttps://django-private-chat2.readthedocs.io\u003e.\n\nQuickstart\n----------\n\nInstall django_private_chat2:\n\n    pip install django_private_chat2\n\nAdd it to your `INSTALLED_APPS`:\n\n```python\nINSTALLED_APPS = (\n    ...\n    'django_private_chat2.apps.DjangoPrivateChat2Config',\n    ...\n)\n```\n\nAdd django_private_chat2's URL patterns:\n\n```python\nfrom django.urls import re_path, include\n\n\nurlpatterns = [\n    ...\n    re_path(r'', include('django_private_chat2.urls', namespace='django_private_chat2')),\n    ...\n]\n```\n\nAdd django_private_chat2's websocket URLs to your `asgi.py`:\n```python\n\ndjango_asgi_app = get_asgi_application()\nfrom channels.routing import ProtocolTypeRouter, URLRouter\nfrom channels.auth import AuthMiddlewareStack\nfrom django_private_chat2 import urls\napplication = ProtocolTypeRouter({\n    \"http\": django_asgi_app,\n    \"websocket\": AuthMiddlewareStack(\n        URLRouter(urls.websocket_urlpatterns)\n    ),\n})\n\n```\n\n\n**Important:**\n\ndjango_private_chat2 doesn't provide any endpoint to fetch users (required to start new chat, for example)\nIt's up to you to do so. The example app does it in `urls.py` so feel free to copy the handler from there if you wish.\n\nSupport\n--------\n\nIt's important for us to have `django_private_chat2` thoroughly tested.\n\nUsing github actions, we're able to have `django_private_chat2` tested against python3.6, python3.7, python3.8, python3.9, python3.10 with Django 3.0, Django 3.1,  Django 3.2, Django 4.0\n\nYou can view the builds here:\n\nhttps://github.com/Bearle/django_private_chat2/actions\n\nThe builds are composed of officially supported Django \u0026 Python combinations.\n\nPlease file an issue if you have any problems with any combination of the above. \n\n\nFeatures\n--------\n\n__Django-related__\n\n-:white_check_mark: Fully-functional example app\n\n-:white_check_mark: Uses Django admin\n\n-:white_check_mark: Supports pluggable User model (and accounts for non-integer primary keys, too)\n\n-:white_check_mark: Doesn't require Django Rest Framework (views are based off django.views.generic)\n\n-:white_check_mark: Configurable via settings\n\n-:white_check_mark: Fully translatable \n\n-:white_check_mark: Uses Django storage system \u0026 FileField for file uploads (swappable)\n\n\n__Functionality-related__\n\n-:white_check_mark: Soft deletable messages\n\n-:white_check_mark: Read/unread messages\n\n-:white_check_mark: Random id (send message first, write to database later)\n\n-:white_check_mark: Supports text \u0026 file messages\n\n-:white_check_mark: Gracefully handles errors\n\n-:white_check_mark: Support 'typing' statuses\n\n-:white_check_mark: Upload the file first, send the message later (async uploads) - potential for file ref re-use later\n\n... and more\n\n\nExample app frontend features\n-----------------------------\n\n1. Auto reconnected websocket\n2. Toasts about errors \u0026 events\n3. Send text messages\n4. Search for users\n5. Create new chat with another user\n6. Online/offline status\n7. Realtime messaging via websocket\n8. Last message\n9. Auto-avatar (identicon) based on user id\n10. Connection status display\n11. `Typing...` status\n12. Message delivery status (sent, received, waiting, etc.)\n13. Message history\n14. Persistent chat list\n15. Read / unread messages\n16. Unread messages counters (updates when new messages are received)\n17. Send file messages (upload them to server)\n\nTODO \n----\n\nFrontend (example app) \u0026 backend\n\n1. Pagination support on frontend\n    1. For messages \n    2. For dialogs\n2. Example app only - user list\n    1. :white_check_mark: Endpoint\n    2. :white_check_mark: UI\n3. :white_check_mark: New dialog support\n4. Online's fetching on initial load\n5. Last message\n    1. :white_check_mark: In fetch\n    2. :white_check_mark: In new dialog\n    3. :white_check_mark: On arriving message\n6. :white_check_mark: Read / unread/ unread count\n7. Last seen\n8. Send photo\n9. :white_check_mark: Send file\n10. Reply to message\n11. Delete message\n12. Forward message\n13. Search for dialog (username)\n    1. :white_check_mark: Frontend (local)\n    2. ~~Server based~~ - won't do, out of the scope of the project\n14. :white_check_mark: Fake data generator (to test \u0026 bench) - done via factories in tests\n15. Cache dialogs (get_groups_to_add) - ?\n16. Move views to async views - ?\n17. Add some sounds\n    1. New message\n    2. New dialog\n    3. Sent message received db_id\n18. Optimize /messages/ endpoint\n19. :white_check_mark:Some tests\n20. Full test coverage\n21. Migration from v1 guide\n22. Documentation\n23. self-messaging (Saved messages)\n\nRunning Tests\n-------------\n\nDoes the code actually work?\n\n    source \u003cYOURVIRTUALENV\u003e/bin/activate\n    (myenv) $ pip install tox\n    (myenv) $ tox\n\nDevelopment commands\n--------------------\n\n    pip install -r requirements_dev.txt\n    invoke -l\n\nCredits\n-------\n\nTools used in rendering this package:\n\n-   [Cookiecutter](https://github.com/audreyr/cookiecutter)\n-   [cookiecutter-djangopackage](https://github.com/pydanny/cookiecutter-djangopackage)\n\nPaid support\n------------\n\nIf you wish to have professional help from the authors of django_private_chat2, or simply hire Django experts to solve a particular problem,\nplease contact us via email `tech` **at** `bearle.ru` or `Bearle` in telegram\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbearle%2Fdjango_private_chat2","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbearle%2Fdjango_private_chat2","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbearle%2Fdjango_private_chat2/lists"}