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.7.tar.gz (7.8 kB view details)

Uploaded Source

Built Distribution

winerp-1.0.7-py3-none-any.whl (3.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: winerp-1.0.7.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.7.tar.gz
Algorithm Hash digest
SHA256 dbe717093c28e72fbacbb65f98da69f954c14e606b250f1fce1562cc2bea9a81
MD5 586f22dcd242b479f2c6a9e116a8d78a
BLAKE2b-256 da79da34af065b6d9f72db0028202e2b60a37f47600b5ba696a6008bd82640e6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: winerp-1.0.7-py3-none-any.whl
  • Upload date:
  • Size: 3.4 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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 621951d4dfb35a34e9c33f6171f38bb7ea8932a38f26e6e5437ac974cafd1f48
MD5 7905171e5e16fe5ef3234bc12e2228f8
BLAKE2b-256 2e5d0118b150172fe4f536292be670dbd10e4f9d8612dcf1d83b4a5d2542230c

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