Merge pull request #1 from interactions-py/ipy-v5

chore: merge `ipy-v5` to `main`

Author: Damego

.pre-commit-config.yaml

@@ -2,7 +2,7 @@ default_language_version:
     python: python3.10
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.3.0
+    rev: v4.4.0
     hooks:
     - id: requirements-txt-fixer
       name: Requirements
@@ -31,23 +31,23 @@ repos:
     - id: check-merge-conflict
       name: Merge Conflicts
   - repo: https://github.com/psf/black
-    rev: 22.3.0
+    rev: 23.1.0
     hooks:
     - id: black
       name: Black Formatting
       language: python
       types: [file, python]
       args: [--line-length=100]
   - repo: https://github.com/PyCQA/flake8
-    rev: 4.0.1
+    rev: 6.0.0
     hooks:
     - id: flake8
       name: flake8 Formatting
       language: python
       types: [file, python]
       args: [--max-line-length=100, --ignore=E203 E301 E302 E501 E402 E704 W503 W504]
   - repo: https://github.com/pycqa/isort
-    rev: 5.10.1
+    rev: 5.12.0
     hooks:
       - id: isort
         name: isort Formatting

README.md

@@ -1,31 +1,59 @@
-# FastAPI wrapper for interactions.py
+# interactions restful
 
-An Extension library to add Fast API for your interactions.py bot .
+A library for interactions.py allowing runtime API structures
 
 ## Installation
 
-``pip install interactions-fastapi``
+Using pip:  
+`pip install interactions-restful`
 
+Using poetry:  
+`poetry add interactions-restful`
 
-## Examples
+Don't forget to specify backend you want to use:
+- flask `pip install interactions-restful[flask]`
+- fastapi  `pip install interactions-restful[fastapi]`
+
+## Simple example
+
+### Main file
+
+```python
+import interactions
+from interactions_restful import setup
+from interactions_restful.backends.fast_api import FastAPI
+
+client = interactions.Client()
+
+setup(client, FastAPI, "127.0.0.1", 5000)
+
+client.load_extension("api")
+
+client.start("token")
+```
+
+### Extension file
+- `api.py`
 
 ```python
 import interactions
-from interactions.ext.fastapi import setup
+from interactions_restful import route
 
-client = interactions.Client(...)
-api = setup(client)
 
-@api.get("/")
-async def index():
-    return {"status": "success"}
+class MyAPI(interactions.Extension):
+    @route("GET", "/")
+    def index(self):
+        return {"status": "Hello, i.py"}
+    
+    @interactions.slash_command()
+    async def test_command(self, ctx):
+        await ctx.send("Hello, API")
 
-client.start()
 ```
 
-Server will run on ``127.0.0.1:32512`` (host and port modifiable)
+## Backends
 
-More examples in ``examples`` folder.
+Currently, library support only flask and fastapi as a backend for building an api, but if you don't want to use them you can create own backend.
 
 ## Documentation
 

examples/bot.py

@@ -1,56 +1,16 @@
-from os import getenv
-
-from dotenv import load_dotenv
-from fastapi import WebSocket, WebSocketDisconnect
-
 import interactions
-from interactions.ext.fastapi import setup
-
-load_dotenv()
-
-bot = interactions.Client(getenv("TOKEN"), intents=interactions.Intents.ALL)
-api = setup(bot)
-
-
-@bot.event()
-async def on_start():
-    print("bot started")
-
-
-@bot.command()
-async def test_command(ctx):
-    await ctx.send("Ok")
-
-
-@api.route("get", "/")
-async def index():
-    return {"test": "yay"}
+from interactions_restful import setup
+from interactions_restful.backends.fast_api import FastAPI
 
 
-@api.get("/guilds/{guild_id}/members/{member_id}")
-async def test(guild_id: int, member_id: int):
-    for guild in bot.guilds:
-        if int(guild.id) == guild_id:
-            break
-    member = await guild.get_member(member_id)
-    return member._json
+client = interactions.Client()
+setup(client, FastAPI, "localhost", 8000)
+client.load_extension("exts.my_ext")
 
 
-@api.websocket("/ws/")
-async def websocket_control(websocket: WebSocket):
-    """
-    Before using you have to install additional requirement:
-    `pip install uvicorn[standard]`
-    """
-    await websocket.accept()
-    await websocket.send_json({"test": "yayayyayayyaya"})
-    try:
-        while True:
-            packet = await websocket.receive_json()
-            print(packet)
-            # some stuff with websocket
-    except WebSocketDisconnect:
-        pass
+@interactions.listen()
+async def on_startup():
+    print(f"Bot `{client.user.username}` started up")
 
 
-bot.start()
+client.start("TOKEN")

examples/exts/cog.py

@@ -0,0 +1,12 @@
+from interactions import Extension, slash_command
+from interactions_restful import route
+
+
+class MyExtension(Extension):
+    @route("GET", "/")
+    async def index(self):
+        return {"data": "hello interactions.py"}
+
+    @slash_command()
+    async def command(self, ctx):
+        await ctx.send("hello, api!")

examples/exts/my_ext.py

@@ -0,0 +1,2 @@
+from .decorators import *
+from .extension import *

interactions/ext/fastapi/__init__.py

@@ -0,0 +1,32 @@
+from abc import ABC, abstractmethod
+from typing import Callable, Coroutine
+
+__all__ = ("BaseApi", "BaseRouter")
+
+
+class BaseRouter(ABC):
+    @abstractmethod
+    def add_endpoint_method(self, coro: Callable[..., Coroutine], endpoint: str, method: str, **kwargs):
+        pass
+
+
+class BaseApi(ABC):
+    @abstractmethod
+    def __init__(self, host: str, port: int, **kwargs):
+        pass
+
+    @abstractmethod
+    def add_endpoint_method(self, coro: Callable[..., Coroutine], endpoint: str, method: str, **kwargs):
+        pass
+
+    @staticmethod
+    @abstractmethod
+    def create_router(**kwargs) -> BaseRouter:
+        pass
+
+    def add_router(self, router: BaseRouter):
+        pass
+
+    @abstractmethod
+    async def run(self):
+        pass