Skip to main content

Websocket based IPC for discord.py bots

Project description

winerp

An IPC based on Websockets. Fast, Stable, and Reliable, perfect for communication between your processes or discord.py bots.

Installation

Stable:

pip install 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 processes. You can connect a large number of clients for sharing data, and data can be shared between any connected client.

Example Usage:

Server Side:

import winerp

server = winerp.Server(port=8080)
server.start()

Client 1 (some-random-bot):

import discord
from discord.ext.commands import Bot

import winerp

bot = Bot(command_prefix="!", intents=discord.Intents.all())

bot.ipc = winerp.Client(local_name = "some-random-bot", loop = bot.loop, 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(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)

import discord
from discord.ext.commands import Bot

import winerp

bot = Bot(command_prefix="?", intents=discord.Intents.all())

bot.ipc = winerp.Client(local_name = "another-bot", loop = bot.loop, 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():
    return "You are very cool"


bot.loop.create_task(bot.ipc.start())
bot.run("TOKEN")

Features

  • Fast: Minimum Response Time Recorded: 0.001s.
  • Reliable, Stable and Easy to integrate.
  • A single hosted server can be used to serve all clients on the machine.
  • No limitation on number of connected clients.
  • Inter bot-communication possible.
  • Inter server-communication possible.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

winerp-1.0.8.tar.gz (7.8 kB view details)

Uploaded Source

Built Distribution

winerp-1.0.8-py3-none-any.whl (7.9 kB view details)

Uploaded Python 3

File details

Details for the file winerp-1.0.8.tar.gz.

File metadata

  • Download URL: winerp-1.0.8.tar.gz
  • Upload date:
  • Size: 7.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.5

File hashes

Hashes for winerp-1.0.8.tar.gz
Algorithm Hash digest
SHA256 3d9eb18872fdb1c0d4347ef6c4b805e12879522ea52a45575dc2a49200cf8b9a
MD5 454ad43ecb597f3d2be9e13b1e316868
BLAKE2b-256 60390ababee62f8e0e8a5fca057e7976797f603c98639e4451897c4162a804f8

See more details on using hashes here.

File details

Details for the file winerp-1.0.8-py3-none-any.whl.

File metadata

  • Download URL: winerp-1.0.8-py3-none-any.whl
  • Upload date:
  • Size: 7.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.5

File hashes

Hashes for winerp-1.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 890a8a3d7c2a1b17dccc80fea7ac965cb7fdc78f182375cc8b3dd4968de588cb
MD5 34650000b0b4e80ba7c5621fd9582045
BLAKE2b-256 173ce211340d7908dd447107fd3d7c941c428f722a38a2dc42dde7e8405da089

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page