Skip to main content

Easy, simple, scalable and modular: a Python API wrapper for interactions.

Project description

interactions.py


Easy, simple, scalable and modular: a Python API wrapper for interactions.

https://img.shields.io/pypi/dm/discord-py-slash-command.svg https://img.shields.io/github/license/goverfl0w/discord-interactions.svg https://img.shields.io/pypi/pyversions/discord-py-interactions.svg https://img.shields.io/pypi/v/discord-py-interactions.svg https://readthedocs.org/projects/discord-interactions/badge/?version=latest https://discord.com/api/guilds/789032594456576001/embed.png

Ever since December 2019, this open-source project has become the culmination of dedication and research towards figuring out the best way to bring interactions from Discord to you: we are an easy, simple, scalable and modular library for Discord interactions.

  • Tired of using numerous module dependencies for slash commands and buttons?

  • Looking for a compatible library that implements all interactions?

  • Itching to get your hands on slash commands, but in a simple manner?

Look no more! The goal of this library is to make all three of these questions go from possibilities to trivial matters.

What can we do?


Our library—inside and out, offers numerous benefits and presents itself as a worthy module in your bot’s dependencies:

The base features of our library, built with our API include:

  • Dynamic object data generation: all event data dispatched from the Gateway is dynamically transformed and generated into two-way serializable JSON objects.

  • Sane rate limiting: our HTTP client implements pre-emptive rate limit avoidance, so your bot is guaranteed to never hit HTTP 429.

  • On-demand cache: every HTTP request and Gateway event made is cached when needed, so you never have to save information yourself.

  • Simplified data models: every object presented is accessible as either a raw dictionary/application/json or list of recursive attributes.

Some more unique features that are exclusive to our interactions include:

  • Event-triggered callbacks: whether a component, application command or interaction response, you’ll never need to worry about bridging responses.

  • Dual-way decorator logic: a decorator can act as both a constructor for an interaction, as well as a callback.

  • API-strict naming: no more confusion with the naming approach of many libraries; we follow the naming style of interactions from the officially curated Discord Developers documentation.

  • Extensive framework structure: (pending in 4.1.0) build your own tools and technologies for our library to develop and integrate community creations.

What do we not offer?


While we certainly offer a lot of benefits, we unfortunately have our own downsides:

  • No native cooldown decorator/method.

  • Lack of automatic sharding and voice clients.

Where do I start?


Please check out our quickstart guide for some basic examples.

How can I contribute?


Please read up on our contribution requirements for the project. This open-source project also enforces the MIT License.

This open-source project utilizes the following workflows for development:

  1. pre-commit 2.16.0: the architecture uses this before every commit to format and check for severity/QOL-breaking changes.

    1. black 21.11b1

    2. flake8 3.9.2

    3. isort 5.9.3

  2. Sphinx 4.1.2: all of our documentation is powered off of autogenerated documentation of the Sphinx engine.

  3. colorama 0.4.4: our internal logger uses a customized coloring formatter to make looking for specific conditions easier when running tests.

  4. Conventional Commits 1.0.0: every commit that we make to our branches use the official specification of CC 1.0.0 to make git graphs easier when improving and refining communication between code reviews, Pull Requests and commits.

When can I start?


We also have some extra ground rules about making any specific contributions involving:

  • We do not accept abstraction-based requests. (e.g. colour for color)

  • A request has to be approved by at least one developer.

  • You must be willing to change/adhere to reviews from participants where necessary.

I think I’m all ready!


Feel free to begin making Pull Requests and Issues on our GitHub!

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

discord-py-slash-command-4.2.1.tar.gz (138.9 kB view details)

Uploaded Source

Built Distribution

discord_py_slash_command-4.2.1-py3-none-any.whl (177.5 kB view details)

Uploaded Python 3

File details

Details for the file discord-py-slash-command-4.2.1.tar.gz.

File metadata

File hashes

Hashes for discord-py-slash-command-4.2.1.tar.gz
Algorithm Hash digest
SHA256 c7dc46c45d44635808f637c7261a5084aeb4d36122d03399c920d5692053ee0e
MD5 0808cbdffeab03fbcdb11ff3a499f301
BLAKE2b-256 bc810db736ae58f607aee1786f90f77bf6f3df03e1b82467aacc68e96e529c01

See more details on using hashes here.

File details

Details for the file discord_py_slash_command-4.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for discord_py_slash_command-4.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7809a99345b4699cf039b2255a49ef3dec7940c335061ca5e13f0a91b0a76194
MD5 95cfa2467290e2ee6003dc89d3b6d6c0
BLAKE2b-256 316c5fac89bfee4e34e9bb797800145359b518afd0751d83aeaf6c1bb627b71b

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