https://github.com/nouman0103/winerp
An IPC based on Websockets, fast, stable, and reliable
https://github.com/nouman0103/winerp
asyncio communication discord discord-ipc inter-process-communication inter-server-communications ipc websocket websockets
Last synced: 3 months ago
JSON representation
An IPC based on Websockets, fast, stable, and reliable
- Host: GitHub
- URL: https://github.com/nouman0103/winerp
- Owner: nouman0103
- License: mit
- Created: 2022-04-05T16:08:39.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-09-01T15:01:02.000Z (almost 3 years ago)
- Last Synced: 2025-12-16T17:15:52.191Z (6 months ago)
- Topics: asyncio, communication, discord, discord-ipc, inter-process-communication, inter-server-communications, ipc, websocket, websockets
- Language: Python
- Homepage: https://pypi.org/project/winerp/
- Size: 172 KB
- Stars: 13
- Watchers: 2
- Forks: 9
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# winerp
An IPC based on Websockets. Fast, Stable, and easy-to-use, for inter-communication between your processes or discord.py bots.
Documentation: https://winerp.readthedocs.io/
Discord Server: https://discord.gg/T28F8hju9Y
> **BREAKING CHANGES (1.4.0):**
The message source name is passed to all registered routes.
Instead of:
> ```py
> @ipc.route() # < v1.4.0
> async def route_name():
> ...
> ```
> Use:
> ```py
> @ipc.route() # >= v1.4.0
> async def route_name(source):
> ...
> ```
### Key Features
- **Fast** with minimum recorded response time being `< 2ms`
- Lightweight, Stable and Easy to integrate.
- No limitation on number of connected clients.
## Installation
Stable:
```py
pip install -U winerp
```
Main branch (can be unstable/buggy):
```py
pip install git+https://www.github.com/BlackThunder01001/winerp
```
### Working:
This library uses a central server for communication between multiple clients. You can connect a large number of clients for sharing data, and data can be shared between any connected client.
1) Import the library:
```py
import winerp
```
2) Initialize winerp client:
```py
ipc_client = winerp.Client(local_name = "my-cool-app", port=8080)
```
3) Start the client:
```py
await ipc_client.start()
# or
asyncio.create_task(ipc_client.start())
```
- Registering routes:
```py
@ipc_client.route
async def route_name(source, user_name):
return f"Hello {user_name}"
```
- Requesting data from another client:
```py
user_name = await ipc_client.request(route="fetch_user_name", source="another-cool-bot", user_id = 123)
```
- Sending *information* type data to other clients:
```py
data = [1, 2, 3, 4]
await ipc_client.inform(data, destinations=["another-cool-bot"])
```
## Example Usage:
Start the server on terminal using `$ winerp --port 8080`. You can also start the server using `winerp.Server`
### Client 1 (`some-random-bot`):
```py
import winerp
import discord
from discord.ext.commands import Bot
bot = Bot(command_prefix="!", intents=discord.Intents.all())
bot.ipc = winerp.Client(local_name = "some-random-bot", port=8080)
@bot.command()
async def request(ctx):
# Fetching data from a client named "another-bot" using route "get_some_data"
data = await bot.ipc.request("get_some_data", source = "another-bot")
await ctx.send(data)
@bot.ipc.route()
async def get_formatted_data(source, user_id = None):
return f"<@{user_id}>"
@bot.ipc.event
async def on_winerp_ready():
print("Winerp Client is ready for connections")
bot.loop.create_task(bot.ipc.start())
bot.run("TOKEN")
```
### Client 2 (`another-bot`)
```py
import winerp
import discord
from discord.ext.commands import Bot
bot = Bot(command_prefix="?", intents=discord.Intents.all())
bot.ipc = winerp.Client(local_name = "another-bot", port=8080)
@bot.command()
async def format(ctx):
# Fetching data from a client named "some-random-bot" using route "get_formatted_data"
data = await bot.ipc.request("get_formatted_data", source = "some-random-bot", user_id = ctx.author.id)
await ctx.send(data)
@bot.ipc.route()
async def get_some_data(source):
return "You are very cool"
bot.loop.create_task(bot.ipc.start())
bot.run("TOKEN")
```