discord-ipc 0.0.4

An IPC extension allowing for the communication between a discord.py bot and an asynchronous web-framework.

Discord IPC

An IPC extension allowing for the communication between a discord.py bot and an asynchronous web-framework.

What is Discord IPC?

Discord IPC is a discord.py extension which allows the communication between a discord.py bot and an asynchronous web-framework. You can use the IPC extension to make a route, set some data, and have it update your command from your website - in turn updating the data of the command.

For example, updating your bot's prefix from the website.

What is Discord IPC compatible with?

Discord IPC is currently compatible with either Quart or aiohttp.web

Installation

As with other extensions, instillation is through pip

Python >=3.5.3 is required.

Linux/macOS

python3 -m pip install -U discord-ipc

Windows

py -m pip install -U discord-ipc

Examples

Client example

import discord
from discord.ext import commands, ipc
from discord.ext.ipc.server import Server
from discord.ext.ipc.objects import ClientPayload

class Bot(commands.Bot):
    def __init__(self) -> None:
        intents = discord.Intents.all()

        super().__init__(
            command_prefix="$",
            intents=intents,
        )

        self.ipc = ipc.Server(self, secret_key="my_secret_key")  # create our IPC Server

    async def setup_hook(self) -> None:
        await self.ipc.start()

    @Server.route()
    async def get_user_data(self, data: ClientPayload) -> Dict:
        user = self.get_user(data.user_id)
        return user._to_mimimal_user_json()

await self.start('token')

You can find more examples in the examples directory.

Support

• Documentation

• Discord Server

• Discord API