discord-interactions.py 0.0.1

A library around the Discord Interactions API

A wrapper for the Discord Interactions API that does not rely on websockets and can therefore be used in a stateless webhook environment.

Installation

Requires Python 3.8+

• latest release from PyPI using pip:

  pip install discord-interactions.py

• latest commit from GitHub using pip and git:

  pip install git+https://github.com/LiBa001/discord-interactions.py

  Note

  This requires you to have Git installed on your computer.

Use with Flask

This library is specifically designed to work seamlessly with the Flask microframework.

The most API-like example with the flask extension is this:

from discord_interactions.flask_ext import Interactions
from discord_interactions import (
    ApplicationCommand, ApplicationCommandOption, ApplicationCommandOptionType,
    Interaction, InteractionResponse, InteractionResponseType, InteractionApplicationCommandCallbackData
)
from flask import Flask
import os

app = Flask(__name__)
interactions = Interactions(app, os.getenv("CLIENT_PUBLIC_KEY"))

echo_cmd = ApplicationCommand("echo", "what goes around comes around")
echo_cmd.add_option(ApplicationCommandOption(
    type=ApplicationCommandOptionType.STRING,
    name="message",
    description="This will be echoed.",
    required=True
))


@interactions.command(echo_cmd)
def _echo(interaction: Interaction):
    msg = interaction.data.options[0].value  # "message" option content

    return InteractionResponse(
        response_type=InteractionResponseType.CHANNEL_MESSAGE_WITH_SOURCE,
        data=InteractionApplicationCommandCallbackData(content=msg)
    )

Here, we use the rudimentary ApplicationCommand, Interaction and InteractionResponse classes, which are in their structure basically exact counterparts of the original API models.

This library provides another abstraction layer, though. Inspired by the concept of database ORMs, it has an Object-Command Mapper (OCM) that lets you define a class for each command which will then serve as both a generic structural description of the command (like ApplicationCommand) and a container for the actual data that is received when the command is called (like Interaction).

So, the simplest possible example looks like this:

from discord_interactions.flask_ext import Interactions
from discord_interactions.ocm import Command, Option
from flask import Flask
import os

app = Flask(__name__)
interactions = Interactions(app, os.getenv("CLIENT_PUBLIC_KEY"))


class _Echo(Command):
    """ what goes around comes around """

    message: str = Option("This will be echoed.", required=True)


@interactions.command()
def _echo(cmd: _Echo):
    return cmd.message