معرفی شرکت ها
channels-easy-0.3.0
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
A thin wrapper around channels consumer to make things EASY
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | channels-easy-0.3.0 |
| نام | channels-easy |
| نسخه کتابخانه | 0.3.0 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | Naman Tamrakar |
| ایمیل نویسنده | namantam1@gmail.com |
| آدرس صفحه اصلی | https://namantam1.github.io/channels-easy |
| آدرس اینترنتی | https://pypi.org/project/channels-easy/ |
| مجوز | MIT |
[](https://codecov.io/gh/namantam1/channels-easy)
[](https://github.com/namantam1/channels-easy/actions/workflows/release.yaml)
[](https://github.com/namantam1/channels-easy/actions/workflows/python-package.yml)
[](https://github.com/psf/black)
# Channels Easy <!-- omit in toc -->
A thin wrapper around channel consumers to make things **EASY**
***Note***: This library currently support only text data which is JSON serializable.
**What problem does this library solve?**
This library simplifies two tasks for now
1. Parse incoming text data as JSON and vice versa.
2. Generate event on the basis of type passed from client side.
**Table of Contents**
- [Installation](#installation)
- [Example](#example)
- [API Usage](#api-usage)
- [Contribute](#contribute)
## Installation
To get the latest stable release from PyPi
```bash
pip install channels-easy
```
As `channels-easy` is a thin wrapper around `channels` so channels must be in your `INSTALLED_APPS` in `settings.py`.
```bash
INSTALLED_APPS = (
...,
'channels',
)
```
## Example
All the naming convention used to implement this library is inspired from [socket.io](https://socket.io/) to make server implementation simple.
Get full example project [here](./example).
**Server side**
```python
# consumers.py
from channels_easy.generic import AsyncWebsocketConsumer
class NewConsumer(AsyncWebsocketConsumer):
async def connect(self):
# join room on connect
await self.join("room1")
await self.accept()
async def disconnect(self, close_code):
# Leave room on disconnect
await self.leave("room1")
async def on_message(self, data):
print("message from client", data)
# output:
# message from client {'text': 'hello'}
await self.emit("message", {"message": "hello from server"}, "room1")
```
**Client side**
```javascript
// client.js
const socket = new WebSocket("ws://localhost:8000/ws/test/");
socket.onmessage = function ({ data }) {
const parsed_data = JSON.parse(data);
console.log(parsed_data);
// output:
// {
// data: {message: 'hello from server'}
// type: "message"
// }
};
socket.onopen = () => {
console.log("websocket connected...");
// send message from client after connected
// send with type `message` to receive from subscribed
// `on_message` event on server side
socket.send(
JSON.stringify({
type: "message",
data: {
text: "hello",
},
})
);
};
```
## API Usage
**Subscribing to events**
We can simply subscribe to a message type as
```python
def on_<type>(self, data):
...
pass
```
so if client send data as
```json
{
"type": "message",
"data": "Hello!"
}
```
We can subscribe to message event as
```python
def on_message(self, data):
...
pass
```
**Emitting Message**
We can emit message to client using same schema that we used above
```python
def on_message(self, data):
...
# some code here
...
self.emit(
"message", # type
{"text": "hello"}, # message dict | str | int | list
["room1"], # room list or string
)
```
Check all APIs [here](https://namantam1.github.io/channels-easy/apis/).
## Contribute
If you want to contribute to this project, please perform the following steps
```bash
# Fork this repository
# Clone your fork
poetry install
git checkout -b feature_branch master
# Implement your feature and tests
git add . && git commit
git push -u origin feature_branch
# Send us a pull request for your feature branch
```
In order to run the tests, simply execute `poetry run pytest`. This will run test created inside
`test` directory.
نیازمندی
| مقدار | نام |
|---|---|
| >=3.0 | Django |
| >=3.0 | channels |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3.7,<4.0 | Python |
نحوه نصب
نصب پکیج whl channels-easy-0.3.0:
pip install channels-easy-0.3.0.whl
نصب پکیج tar.gz channels-easy-0.3.0:
pip install channels-easy-0.3.0.tar.gz