Add More Classifiers & Fix Typo ✨ (#3)

* FIx FastAPI-Class

* Create a Config File

* Bump Version to 1.1.0

Author: yezz123

Diff for: .github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,4 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Security Contact
+    about: Please report security vulnerabilities to [email protected]

Diff for: README.md

@@ -32,7 +32,8 @@ def parse_arg() -> argparse.Namespace:
 class UserRoutes(Routable):
    """Inherits from Routable."""
 
-   # Note injection here by simply passing values to the constructor. Other injection frameworks also
+   # Note injection here by simply passing values to the constructor.
+   # Other injection frameworks also work.
    # supported as there's nothing special about this __init__ method.
    def __init__(self, pong: pong) -> None:
       """Constructor. The pong is injected here."""
@@ -50,7 +51,7 @@ class UserRoutes(Routable):
 
 def main():
     args = parse_args()
-    # Configure the pomg per command line arguments
+    # Configure the pong per command line arguments
     pong = pong(args.url, args.user, args.password)
     # Simple intuitive injection
     user_routes = UserRoutes(pong)
@@ -78,6 +79,7 @@ __Note:__ that `app` is a global. Furthermore, [FastAPI's suggested way of doing
 app = FastAPI()
 
 class ValueToInject:
+   # Value to inject into the function.
    def __init__(self, y: int) -> None:
       self.y = y
 

Diff for: Setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.0.0
+current_version = 1.1.0
 commit = True
 tag = True
 

Diff for: fastapi_class/__init__.py

@@ -2,7 +2,7 @@
     FastAPI_Class : contains classes and decorators to use FastAPI with "class based routing".
 """
 
-__version__ = "1.0.0"
+__version__ = "1.1.0"
 
 from fastapi_class import args, decorators, routable
 

Diff for: fastapi_class/routable.py

@@ -13,7 +13,8 @@
     This module contains the `Routable` class, which is used to define a class
 
     Returns:
-        [type] -- [description]
+        [Routable]: A class that can be used to define a routable class
+
 """
 
 
@@ -24,7 +25,9 @@ class member called _endpoints that the Routable constructor then uses to add th
     def __new__(
         cls: Type[type], name: str, bases: Tuple[Type[Any]], attrs: Dict[str, Any]
     ) -> "RoutableMeta":
-        endpoints: List[EndpointDefinition] = []
+        endpoints: List[EndpointDefinition] = [
+            # This is a list of all the endpoints that were defined on the class
+        ]
         # Loop through all the methods in the class
         for v in attrs.values():
             if inspect.isfunction(v) and hasattr(v, "_endpoint"):
@@ -43,7 +46,9 @@ class Routable(metaclass=RoutableMeta):
         router.
     """
 
-    _endpoints: List[EndpointDefinition] = []
+    _endpoints: List[EndpointDefinition] = [
+        # This is a list of all the endpoints that the class has
+    ]
 
     def __init__(self) -> None:
         # Create a router for the class

Diff for: setup.py

@@ -1,6 +1,6 @@
 import setuptools
 
-__version__ = "1.0.0"
+__version__ = "1.1.0"
 
 with open("README.md", "r", encoding="utf-8") as fh:
     long_description = fh.read()
@@ -13,15 +13,23 @@
     description="Generate Class & Decorators for your FastAPI project",
     long_description=long_description,
     long_description_content_type="text/markdown",
-    url="https://github.com/yezz123/fastapi-class",
+    project_urls={
+        "Source Code": "https://github.com/yezz123/fastapi-class",
+        "Bug Tracker": "https://github.com/yezz123/fastapi-class/issues",
+    },
     packages=setuptools.find_packages(
         exclude=["tests", "tests.*", "*.tests", "*.tests.*"],
     ),
     include_package_data=True,
     classifiers=[
-        "Programming Language :: Python :: 3",
         "License :: OSI Approved :: MIT License",
         "Operating System :: OS Independent",
+        "Intended Audience :: Developers",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3 :: Only",
+        "Topic :: Utilities",
+        "Typing :: Typed",
     ],
     python_requires=">=3.8",
     install_requires=["fastapi==0.68.1", "pydantic==1.8.2"],

Diff for: tests/test_routable.py

@@ -32,8 +32,8 @@ def sub(self, x: int) -> int:
     async def do_async(self) -> int:
         return self.__injected + 1
 
-    @get(path="/aecho/{val}", response_class=PlainTextResponse)
-    async def aecho(self, val: str) -> str:
+    @get(path="/echo/{val}", response_class=PlainTextResponse)
+    async def echo(self, val: str) -> str:
         return f"{val} {self.__injected}"
 
 
@@ -99,6 +99,6 @@ def test_async_methods_with_args_work() -> None:
 
     client = TestClient(app)
 
-    response = client.get("/aecho/hello")
+    response = client.get("/echo/hello")
     assert response.status_code == 200
     assert response.text == "hello 2"