ChannelBox is a convenient tool for Starlette framework that allows you send messages to groups of channels.
Project description
ChannelBox
ChannelBox is a convenient 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/ChannelBox
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 group_send
from channel_box import groups_show
from channel_box import groups_flush
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 recivied %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):
groups_show()
await group_send("group_1", {"username": "send from ChatView", "message": "Hello from ChatView"})
return HTMLResponse(html1)
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():
group = f"group_{group_id}"
await self.get_or_create(group)
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):
await self.get_or_create('my_chat_1')
await self.get_or_create('alert_channel_1')
Send message to group:
self.group_send('my_chat_1', {"username": "New User", "message": "Hello world"})
self.group_send('alert_channel_1', {"a": "New User", "message": "Hello world"})
Global functions
Send message to group from any part of your code:
await group_send('my_chat_1', {"username": "New User", "message": "Hello world"})
Show groups and channels:
groups_show()
Flush all groups and channels:
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file channel_box-0.1.1-py3-none-any.whl.
File metadata
- Download URL: channel_box-0.1.1-py3-none-any.whl
- Upload date:
- Size: 4.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
299c9f472c17884ef1f619378069c68d58105b8440b762a1c7f201598a4cea91
|
|
| MD5 |
1309a9a2fe199260c389ea30ca24b82c
|
|
| BLAKE2b-256 |
1a18643a19b24349b7f4aa2d975f55c9cfb8ae0ae5ffdfbc184f89b69f517ff4
|
