winerp
An IPC based on Websockets. Fast, Stable, and easy-to-use, for inter-communication between your processes or discord.py bots.
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:
pip install -U winerp
Main branch (can be unstable/buggy):
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.
- Import the library:
import winerp
- Initialize winerp client:
ipc_client = winerp.Client(local_name = "my-cool-app", port=8080)
- Start the client:
await ipc_client.start()
# or
asyncio.create_task(ipc_client.start())
- Registering routes:
@ipc_client.route
async def route_name(source, user_name):
return f"Hello {user_name}"
- Requesting data from another client:
user_name = await ipc_client.request(route="fetch_user_name", source="another-cool-bot", user_id = 123)
- Sending information type data to other clients:
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
some-random-bot
):
Client 1 (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")
another-bot
)
Client 2 (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")