Code Monkey home page Code Monkey logo

library's Introduction

interactions.py

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

image

image

image

image

image

image


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: 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:

Note

This list is subject to change as time goes on: some of these items may be added to the core of the library in the future.

  • 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.20.0: the architecture uses this before every commit to format and check for severity/QOL-breaking changes.
    1. black 22.6.0
    2. flake8 4.0.1
    3. isort 5.10.1
  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!

library's People

Contributors

i0bs avatar fayedel avatar eunwoo1104 avatar edvraz avatar benwoo1110 avatar catalyst4222 avatar anothercat avatar lordofpolls avatar damego avatar toricane avatar astreatss avatar pre-commit-ci[bot] avatar nanrech avatar lilspazjoekp avatar maxyolo01 avatar v3ntus avatar b1ue-dev avatar geekid812 avatar artem30801 avatar meidonohitsuji avatar 4surix avatar boehs avatar stellaurora avatar kyteware avatar mathiassven avatar chweesee avatar robotic-coder avatar donbur4156 avatar jalancar avatar anand2312 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.