ChannelBox it is a simple tool for Starlette framework that allows you send messages to groups of channels.
Project description
ChannelBox
ChannelBox it is a simple tool for Starlette framework that allows you send messages to groups of channels.
Example of use:
- chats
- notifications from backend
- alerts
https://github.com/Sobolev5/channel-box
How to use it
To install run:
pip install channel-box
Modify your urls.py:
from starlette.routing import Route
from starlette.routing import WebSocketRoute
from .views import ChatView
from .views import ChatSocket
routes = [
Route("/", endpoint=ChatView),
WebSocketRoute("/chat_ws", ChatSocket),
]
Add the following lines to your views.py file:
from starlette.endpoints import HTTPEndpoint
from starlette.responses import HTMLResponse
from channel_box import ChannelEndpoint
from channel_box import channel_groups
html = """
<!DOCTYPE html>
<html>
<head>
<title>ws</title>
</head>
<body>
<h1>WebsocketChannelEndpoint</h1>
<form action="" onsubmit="sendMessage(event)">
<label>group_id: </label><input type="text" id="groupId" autocomplete="off" value="1"><br/>
<label>username: </label><input type="text" id="username" autocomplete="off" value="test_user1"><br/>
<label>message: </label><input type="text" id="messageText" autocomplete="off" value="test_message1"><br/>
<button>Send</button>
</form>
<ul id='messages'>
</ul>
<script>
var ws = new WebSocket("ws://localhost/chat_ws");
ws.onmessage = function(event) {
console.log('Message receivied %s', event.data)
var messages = document.getElementById('messages');
var message = document.createElement('li');
var data = JSON.parse(event.data);
message.innerHTML = `<strong>${data.username} :</strong> ${data.message}`;
messages.appendChild(message);
};
function sendMessage(event) {
var username = document.getElementById("username");
var group_id = document.getElementById("groupId");
var input = document.getElementById("messageText");
var data = {
"group_id": group_id.value,
"username": username.value,
"message": input.value,
};
console.log('Message send %s', data)
ws.send(JSON.stringify(data));
event.preventDefault();
}
</script>
</body>
</html>
"""
class ChatView(HTTPEndpoint):
async def get(self, request):
channel_groups.groups_show()
await channel_groups.group_send("group_1", {"username": "ChatView", "message": "Hello from ChatView"})
return HTMLResponse(html)
class ChatSocket(ChannelEndpoint):
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.expires = 1600
self.encoding = "json"
async def on_receive(self, websocket, data):
group_id = data["group_id"]
message = data["message"]
username = data["username"]
if message.strip():
self.get_or_create(group_id)
payload = {
"username": username,
"message": message,
}
await self.group_send(payload)
ChannelEndpoint methods
Change encoding and expires time on initial (default values is self.expires = 60 * 60 * 24, self.encoding = "json"):
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.expires = 1600
self.encoding = "json"
Get or create group by name (only ASCII symbols allowed):
self.get_or_create('my_chat_1')
self.get_or_create('alert_channel_1')
Send message to group:
await self.group_send('my_chat_1', {"username": "New User", "message": "Hello world"})
await self.group_send('alert_channel_1', {"username": "New User", "message": "Hello world"})
channel_groups methods
Send message to any group from any part of your code:
await channel_groups.group_send('my_chat_1', {"username": "New User", "message": "Hello world"})
Show groups and channels:
channel_groups.groups_show()
Flush all groups and channels:
channel_groups.groups_flush()
Working example
https://github.com/Sobolev5/starlette-vue-backend/tree/master/apps/chat
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
Close
Hashes for channel_box-0.2.1-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e44fc5b6821fdb6098121e14860ca110e2d443fa015181cd946c5b128158311e |
|
| MD5 | 1e4156a2a0f3595d4a868545a7fca155 |
|
| BLAKE2b-256 | f95f5010018694fa8188f4820fc8b96310d71e0c10db6eb875d803d0350f6be3 |
