django-chit-chat 
chat for projects we help maintain @ ckc
installing
pip install django-chit-chat# settings.py
INSTALLED_APPS = (
"django.contrib.auth",
"django.contrib.contenttypes",
"django.contrib.sessions",
"django.contrib.staticfiles",
# ... add chit_chat
"chit_chat",
)# routing.py
from channels.auth import AuthMiddlewareStack
from django.core.asgi import get_asgi_application
from channels.routing import ProtocolTypeRouter, URLRouter
import chit_chat.routing
application = ProtocolTypeRouter({
'http': get_asgi_application(),
'websocket': AuthMiddlewareStack(
URLRouter(
chit_chat.routing.websocket_urlpatterns
)
),
})# urls.py
from rest_framework import routers
from chit_chat.viewsets import RoomViewSet
router = routers.SimpleRouter()
router.register('chatrooms', RoomViewSet)
urlpatterns = router.urls<!-- chat.html -->
<script>
// Open a connection to django-chit-chat
YourWebsocketThing.open(`wss://${window.location.host}/ws/chatroom/`)
// Write messages to screen as they're sent/received
YourWebsocketThing.onmessage(msg => writeMessageToScreen(JSON.parse(msg.data)))
// You can do a GET to "/api/chatrooms/" for a list of chatrooms + messages
$.get("/api/chat/rooms").success(d => ...)
// Send a message
function send_message(text) {
WSClient.send(JSON.stringify({
message_type: "chat",
room: 1, // ID of chat room
text: text
}))
}
</script>tests
$ docker build -t django-chit-chat . && docker run django-chit-chat pytestReleasing
- Update version number in
setup.cfg. -
Create release using Github's UI.
- Click the
Choose a tagdropdown and create a new tag with the new version number. - Click the
Generate release notesbutton to automatically create release notes. - This will trigger an action to build and push the release to PyPi.
- Click the
