Merge pull request #384 from goverfl0w/unstable

Reflect new unstable fixes to stable.

Author: i0bs

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,14 +1,15 @@
-## About this Pull Request
+## About
 
-This pull request does (insert here), which effectively solves issues (X) and (Y).
+This pull request is about (X), which does (Y).
 
 ## Checklist
 
-- [ ] I've run the `pre_push.py` script to format and lint the change(s) made.
-- [ ] I've checked to make sure this pull request runs on Python `3.6.X`.
-- [ ] This fixes/solves something from the project's [Issues](https://github.com/goverfl0w/discord-interactions/issues).
-    - Issue (if referenceable):
-- [ ] This adds something new.
-    - [ ] This is not a code change.
-    - [ ] (If required) Relevant documentation has been updated/added.
-    - [ ] There is/are (a) breaking change(s).
+- [ ] I've ran `pre-commit` to format and lint the change(s) made.
+- [ ] I've checked to make sure the change(s) work on `3.8.6` and higher.
+- [ ] This fixes/solves an [Issue](https://github.com/goverfl0w/discord-interactions/issues).
+  - (If existent):
+- [ ] I've made this pull request for/as: (check all that apply)
+  - [ ] Documentation
+  - [ ] Breaking change
+  - [ ] New feature/enhancement
+  - [ ] Bugfix

.gitignore

@@ -10,3 +10,5 @@ dist/
 .env
 .venv
 .vscode
+__pycache__
+.token

.token

@@ -0,0 +1 @@
+ODgzNzg4ODkzNTEyNjgzNTIw.YTPCjA.HUk8b7AkX-C2t3Hv_gOvktUHUXk

docs/_static/banner.png

@@ -5,12 +5,6 @@ API Reference
 
 This page outlines the API wrapper of discord-interactions.
 
-.. warning::
-
-    As of the time of this writing, version 4.0 of discord-interactions
-    has not yet been released, which this documentation currently reflects.
-    The documentation written here is subject to change and is not finalized.
-
 Interactions
 ************
 

docs/api.rst

@@ -30,7 +30,24 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ["sphinx.ext.autodoc", "sphinx.ext.intersphinx", "karma_sphinx_theme"]
+autosectionlabel_prefix_document = True
+hoverxref_auto_ref = True
+hoverxref_sphinxtabs = True
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.autosectionlabel",
+    "hoverxref.extension",
+    "karma_sphinx_theme",
+]
+
+# Stackoverflow said that this is gonna cure my LaTeX errors for ref handling.
+# https://stackoverflow.com/questions/67485567/sphinx-cross-reference-in-latex
+latex_elements = {
+    "preamble": r"""
+\renewcommand{\hyperref}[2][]{#2}
+"""
+}
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
@@ -40,8 +57,9 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "de"
 locale_dirs = ["locale/"]
+gettext_compact = True
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.

docs/conf.py

@@ -6,16 +6,10 @@ Got a question about our library? Well, your answer is probably laying somewhere
 .. note::
 
     This page is maintained by the Helpers of the Discord server,
-    and updated by the library developer at their discretion. For any
+    and developers at their discretion. For any
     comments, feedback or concerns please consider joining our server
     and bringing it up in our support channels.
 
-.. warning::
-
-    This FAQ list currently reflects v4.0 as of the time of this writing,
-    all other versions are considered deprecated. Because of this, there
-    will not be any answers for questions regarding v3.0 and below.
-
 discord.py is dead! Will this library die too?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 The short answer is: **no**.

docs/faq.rst

@@ -2,53 +2,92 @@
 
 discord-interactions
 ====================
-No more hassle with trying to get interactions to work with your Python Discord bot
--- **discord-interactions** is now here.
+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.
 
-**discord-interactions** is a simple API wrapper for Discord interactions.
-We're not here to replace discord.py or any other fork, but we are here to be the very best
-Python Discord library there is that implements interactions very well. This is what our
-library is all about.
+- 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?
 
-What are we good for?
-*********************
-These are the biggest advantages that you will receive out of using our library:
+Look no more! The goal of this library is to make all three of these questions go from possibilites 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.
 
-* Modern library architecture design for easy modularity and scalability.
-* Sane HTTP 429 ratelimiting.
-* Dynamic object data generation via. dispatch.
-* On-demand caching.
-* `await`/async coroutine functionality.
+Some more unique features that are exclusive to our interactions include:
 
-What does that mean?
-^^^^^^^^^^^^^^^^^^^^
-We're basically the library you'll want to use for these specific things:
+- **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.
 
-* ✔️ Working with application commands and components. (Interactions)
-* ✔️ Handling data from any text channel, cached and dispatched.
-* ✔️ General permissions handling on guild members.
-* ✔️ Responsive callbacks for components.
+What do we not offer?
+*********************
+While we certainly offer a lot of benefits, we unfortunately have our own downsides:
 
-We won't be doing these things as a core aspect of our library, however:
+.. 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.
 
-* ❌ Voice client capabilities.
-* ❌ Cooldowns/bucket types.
+- No native cooldown decorator/method.
+- Lack of automatic sharding and voice clients.
 
 Where do I start?
 *****************
-Please look at our pages below to find out where to go further.
+Please look at our pages below to find out where to go.
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: Pages:
 
    quickstart.rst
    api.rst
    faq.rst
 
+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:
+
+#. **pre-commit** ``2.16.0``: the architecture uses this before every commit to format and check for severity/QOL-breaking changes.
+
+   #. **black** ``21.11b1``
+   #. **flake8** ``3.9.2``
+   #. **isort** ``5.9.3``
+
+#. **Sphinx** ``4.1.2``: all of our documentation is powered off of autogenerated documentation of the Sphinx engine.
+#. **colorama** ``0.4.4``: our internal logger uses a customized coloring formatter to make looking for specific conditions easier when running tests.
+#. **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!
+
 Advanced Search
 ===============
 
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
+
+.. _contribution requirements: https://github.com/goverfl0w/discord-interactions/blob/stable/CONTRIBUTING.md
+.. _MIT License: https://github.com/goverfl0w/discord-interactions/blob/stable/LICENSE
+.. _Pull Requests: https://github.com/goverfl0w/discord-interactions/pulls
+.. _Issues: https://github.com/goverfl0w/discord-interactions/issues

docs/index.rst

@@ -31,6 +31,8 @@ msgid ""
 "No more hassle with trying to get interactions to work with your Python "
 "Discord bot -- **discord-interactions** is now here."
 msgstr ""
+"Kein Ärger mehr, Interaktionen mit Ihrem Python Discord Bot "
+"zum Laufen zu bringen -- **discord-interactions** ist jetzt da."
 
 #: ../../index.rst:8
 msgid ""
@@ -39,26 +41,30 @@ msgid ""
 " we are here to be the very best Python Discord library there is that "
 "implements interactions very well. This is what our library is all about."
 msgstr ""
+"**discord-interactions** ist ein einfacher API-Wrapper für Discord "
+"Interaktionen. Wir sind nicht hier, um discord.py oder einen anderen Fork zu ersetzen, aber"
+"Wir sind hier, um die beste Python Discord-Bibliothek zu sein, die es gibt"
+"Implementiert Interaktionen sehr gut. Darum geht es in unserer Bibliothek."
 
 #: ../../index.rst:14
 msgid "What are we good for?"
-msgstr ""
+msgstr "Wofür sind wir gut?"
 
 #: ../../index.rst:15
 msgid "We offer a **lot** of benefits with using our library:"
-msgstr ""
+msgstr "Wir bieten **viele** Vorteile bei der Nutzung unserer Bibliothek:"
 
 #: ../../index.rst:17
 msgid "Modern pythonic design that is scalable and modular."
-msgstr ""
+msgstr "Modernes Python-Design, das skalierbar und modular ist."
 
 #: ../../index.rst:18
 msgid "Asynchronous coroutines and multi-threading capabilities."
-msgstr ""
+msgstr "Asynchrone Coroutinen und Multithreading-Fähigkeiten."
 
 #: ../../index.rst:19
 msgid "Optimal class object reference with little overhead."
-msgstr ""
+msgstr "Optimale Klassenobjektreferenz mit geringem Overhead."
 
 #: ../../index.rst:20
 msgid "Easily accessible codebase source."