docs: improve documentation on extensions (#555)

* docs: improve documentation on extensions
Also it changes the variable and parameter names:
From `dependencies` and `_dependencies` to `packages` and `_packages`.
Also modifies docstrings related to the line above.

* feat: implement optional additional kwargs for setup()

Author: Toricane

docs/ext.gettingstarted.rst

@@ -47,20 +47,26 @@ This code shows a basic example for creating the base of a 3rd party:
 
 .. code-block:: python
 
-    from interactions.ext import Base, build, Version
-
+    from interactions.ext import Base, build, Version, VersionAuthor
+
+    version = (
+        Version(
+            version="0.0.1",
+            author=VersionAuthor(
+                name="name",
+                email="[email protected]",
+            ),
+        ),
+    )
     data = {
-        "name": "interactions.ext.name_here"
-        "description": "We do cool things!"
-        "version": Version(version="0.0.1")
-        "link": "https://example.com"
+        "name": "interactions-name_here",
+        "description": "We do cool things!",
+        "version": version
+        "link": "https://example.com",
+        "packages": ["interactions.ext.name_here"]
     }
-    class MyThirdParty(Base):
-        def __init__(self):
-            super().__init__(**data)
 
-    library = MyThirdParty()
-    build(library)
+    build(Base(**data))
 
 This configures the base of the library in a rather simple manner: you give the name
 and description of the 3rd party, as well as its own official version and link for

interactions/ext/base.py

@@ -15,14 +15,15 @@ class Base:
     :ivar str description: The description of the library.
     :ivar Optional[str] long_description: The long description of the library.
     :ivar str link: The repository link or the library.
-    :ivar Optional[List[str]] _dependencies: The dependencies of the library needed.
+    :ivar Optional[List[str]] _packages: The packages of the library.
     :ivar Optional[List[str]] _requirements: The modules in the library required.
     :ivar Dict[str, object] __objects: The objects running under the service.
     """
 
     __slots__ = (
-        "_dependencies",
+        "_packages",
         "_requirements",
+        "_kwargs",
         "__objects",
         "version",
         "name",
@@ -38,8 +39,9 @@ def __init__(
         link: str,
         description: str,
         long_description: Optional[str] = None,
-        dependencies: Optional[List[str]] = None,
+        packages: Optional[List[str]] = None,
         requirements: Optional[List[str]] = None,
+        **kwargs: Optional[dict],
     ) -> None:
         """
         :param name: The name of the library.
@@ -52,18 +54,21 @@ def __init__(
         :type description: str
         :param long_description?: The full description of the library, e.g. README. Defaults to ``None``.
         :type long_description: Optional[str]
-        :param dependencies?: The dependencies/other modules needed for library function. Defaults to ``None``.
-        :type dependencies: Optional[List[str]]
+        :param packages?: The package(s) of the library. Defaults to ``None``.
+        :type packages: Optional[List[str]]
         :param requirements?: The required modules needed for library function. Defaults to ``None``.
         :type requirements: Optional[List[str]]
+        :param kwargs?: Any other keyword arguments. Defaults to ``None``.
+        :type kwargs: Optional[dict]
         """
         self.version = version
         self.name = name
         self.link = link
         self.description = description
         self.long_description = long_description
-        self._dependencies = dependencies
+        self._packages = packages
         self._requirements = requirements
+        self._kwargs = kwargs
         self.__objects = {}
 
     def _check_service(self, name: str) -> bool:
@@ -136,6 +141,7 @@ def build(base: Base) -> None:
         author=base.version.author,
         author_email=base.version.author.email,
         url=base.link,
-        packages=[] if base._dependencies is None else base._dependencies,
+        packages=[] if base._packages is None else base._packages,
         install_requires=[] if base._requirements is None else base._requirements,
+        **base._kwargs,
     )

interactions/ext/base.pyi

@@ -2,16 +2,14 @@ from typing import Dict, List, Optional, Union
 
 from .version import Version
 
-
 class Base:
-    _dependencies: Optional[List[str]]
+    _packages: Optional[List[str]]
     _requirements: Optional[List[str]]
     __objects: Dict[str, object]
     version: Version
     name: str
     description: str
     link: str
-
     def __init__(
         self,
         *,
@@ -20,12 +18,12 @@ class Base:
         link: str,
         description: str,
         long_description: Optional[str] = None,
-        dependencies: Optional[List[str]] = None,
+        packages: Optional[List[str]] = None,
         requirements: Optional[List[str]] = None,
-    ) -> None:
+    ) -> None: ...
     def _check_service(self, name: str) -> bool: ...
     def add_service(self, obj: object, name: str) -> Dict[str, object]: ...
     def remove_service(self, name: str) -> Union[Exception, bool]: ...
     @property
     def services(self) -> Dict[str, object]: ...
-    def build(self) -> None: ...
+def build(base: "Base") -> None: ...