chore: reflect unstable additions to stable. (#449)

chore: reflect unstable additions to stable.

Author: i0bs

.gitignore

@@ -3,6 +3,7 @@
 *.egg-info/
 *.eggs/
 *.pyc
+.idea
 .cache/
 _build/
 build/
@@ -11,5 +12,5 @@ dist/
 .venv
 .vscode
 __pycache__
-
 *.token
+*.pypirc

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.0.1
+    rev: v4.1.0
     hooks:
     - id: requirements-txt-fixer
       name: Requirements
@@ -39,7 +39,7 @@ repos:
       name: flake8 Formatting
       language: python
       types: [file, python]
-      args: [--max-line-length=100, --ignore=E203 E501 E402 W503 W504]
+      args: [--max-line-length=100, --ignore=E203 E301 E302 E501 E402 E704 W503 W504]
   - repo: https://github.com/pycqa/isort
     rev: 5.10.1
     hooks:

CONTRIBUTING.rst

@@ -10,7 +10,7 @@ the library off of pip:
 
 .. code-block:: bash
 
-    pip install -U discord-py-interactions
+    pip install -U discord-py-interactions[dev]
 
 Once you have the library installed in Python, you are able to instantiate and run a basic bot
 with a logging level that is set for debugging purposes. This is recommend in order to make it easier

LICENSE

@@ -36,7 +36,7 @@ Ever since December 2019, this open-source project has become the culmination of
 - 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 possibilites to trivial matters.
+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?
 ***************

README.rst

@@ -48,36 +48,48 @@ What does that mean? Well, we'll show you:
     import interactions
     from discord.ext import commands
 
-    interactions = interactions.Client(token="...")
+    client = interactions.Client(token="...")
     dpy = commands.Bot(prefix="/")
 
     @dpy.command()
     async def hello(ctx):
         await ctx.send("Hello from discord.py!")
 
-    @interactions.command(
+    @client.command(
         name="test",
         description="this is just a testing command."
     )
     async def test(ctx):
         await ctx.send("Hello from discord-interactions!")
 
-    interactions.start()
-    dpy.run(token="...", bot=True)
+    loop = asyncio.get_event_loop()
+
+    task2 = loop.create_task(dpy.start(token="...", bot=True))
+    task1 = loop.create_task(client.ready())
+
+    gathered = asyncio.gather(task1, task2, loop=loop)
+    loop.run_until_complete(gathered)
 
 Both of these variables ``interactions`` and ``dpy`` will be able to run in the same established environment, and additionally
-will both function properly as their respective libraries intend them to. What about the models, though? That's a simple answer:
+will both function properly as their respective libraries intend them to. This implementation uses asyncio.gather to execute
+both starts simultaneously as asyncio tasks, and runs them under one singular loop.
+
+Compared to traditional startup commands, ``interactions.ready()`` and ``dpy.start()`` is used instead of
+the typical ``interactions.start()`` and ``dpy.run()`` methods because of synchronous/async functions.
+``asyncio.gather()`` works with coroutines, hence the transition.
+
+What about the models, though? That's a simple answer:
 
 .. code-block:: python
 
     import discord
-    from interactions.api.models.member import Member
+    import interactions
 
     @dpy.command()
-    async def borrowing(ctx, member: Member):
+    async def borrowing(ctx, member: interactions.Member):
         await ctx.send(f"Member ID: {member.id}")
 
-    @interactions.command(...)
+    @client.command(...)
     async def second_borrowing(ctx, member: discord.Member):
         await ctx.send(f"Member ID: {member.id}")
 
@@ -127,6 +139,26 @@ of discord.py bot developers frown upon doing, so this is at your own risk to co
 can take a page out of discord.js' book if you want to do this, since they've never heard of an external command handler framework
 before in their entire life.
 
+
+I'm getting "``AttributeError: HTTPClient not found!``" when I try to execute helper methods!
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Probably you are doing something like this:
+
+.. code-block:: python
+
+    channel = interactions.Channel(**await bot.http.get_channel(channel_id))
+    await channel.send("...")
+
+And the error occurs in the line where you try to send something. You can fix this easy by adding one argument:
+
+.. code-block:: python
+
+    channel = interactions.Channel(**await bot.http.get_channel(channel_id), _client=bot.http)
+    await channel.send("...")
+
+You have to add this extra argument for every object you instantiate by yourself if you want to use it's methods
+
+
 My question is not answered on here!
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Please join our Discord server for any further support regarding our library and/or any integration code depending on it.

docs/faq.rst

@@ -12,9 +12,9 @@
 Co-authored by DeltaXW.
 """
 from .api.models.channel import *  # noqa: F401 F403
+from .api.models.flags import *  # noqa: F401 F403
 from .api.models.guild import *  # noqa: F401 F403
 from .api.models.gw import *  # noqa: F401 F403
-from .api.models.intents import *  # noqa: F401 F403
 from .api.models.member import *  # noqa: F401 F403
 from .api.models.message import *  # noqa: F401 F403
 from .api.models.misc import *  # noqa: F401 F403

interactions/__init__.py

@@ -1,15 +1,10 @@
 from asyncio import get_event_loop
-from logging import Logger, StreamHandler, basicConfig, getLogger
+from logging import Logger
 from typing import Coroutine, Optional
 
-from ..base import CustomFormatter, Data
+from interactions.base import get_logger
 
-basicConfig(level=Data.LOGGER)
-log: Logger = getLogger("dispatch")
-stream: StreamHandler = StreamHandler()
-stream.setLevel(Data.LOGGER)
-stream.setFormatter(CustomFormatter())
-log.addHandler(stream)
+log: Logger = get_logger("dispatch")
 
 
 class Listener:

interactions/api/dispatch.py

@@ -24,7 +24,7 @@ class InteractionException(Exception):
         and for extensive testing/review before integration.
         Likewise, this will show the concepts before use, and will be refined when time goes on.
 
-    :ivar interactions.api.error.ErrorFormatter _formatter: The built in formatter.
+    :ivar interactions.api.error.ErrorFormatter _formatter: The built-in formatter.
     :ivar dict _lookup: A dictionary containing the values from the built-in Enum.
 
     """
@@ -145,7 +145,7 @@ class GatewayException(InteractionException):
     """
     This is a derivation of InteractionException in that this is used to represent Gateway closing OP codes.
 
-    :ivar ErrorFormatter _formatter: The built in formatter.
+    :ivar ErrorFormatter _formatter: The built-in formatter.
     :ivar dict _lookup: A dictionary containing the values from the built-in Enum.
     """
 
@@ -178,7 +178,7 @@ class HTTPException(InteractionException):
     """
     This is a derivation of InteractionException in that this is used to represent HTTP Exceptions.
 
-    :ivar ErrorFormatter _formatter: The built in formatter.
+    :ivar ErrorFormatter _formatter: The built-in formatter.
     :ivar dict _lookup: A dictionary containing the values from the built-in Enum.
     """
 
@@ -204,7 +204,7 @@ class JSONException(InteractionException):
     """
     This is a derivation of InteractionException in that this is used to represent JSON API Exceptions.
 
-    :ivar ErrorFormatter _formatter: The built in formatter.
+    :ivar ErrorFormatter _formatter: The built-in formatter.
     :ivar dict _lookup: A dictionary containing the values from the built-in Enum.
     """