config and run pre-commit

Author: wiseaidev

.env.example

@@ -20,4 +20,4 @@ CORS_ORIGINS=localhost
 DETA_PROJECT_KEY=
 
 # OpenAI
-OPENAI_API_KEY=
+OPENAI_API_KEY=

.pre-commit-config.yaml

@@ -51,7 +51,7 @@ repos:
           - "--no-warn-return-any"
 
   - repo: https://github.com/PyCQA/autoflake
-    rev: 'v2.0.0'
+    rev: 'v2.2.1'
     hooks:
       - id: autoflake
         args:
@@ -62,8 +62,8 @@ repos:
           - "--remove-all-unused-imports"
           - "--remove-unused-variables"
           - "--ignore-init-module-imports"
-
-  - repo: https://github.com/PyCQA/pylint
-    rev: 'v3.0.0-a5'
-    hooks:
-      - id: pylint
+  # TODO
+  # - repo: https://github.com/PyCQA/pylint
+  #   rev: 'v3.0.0-a5'
+  #   hooks:
+  #     - id: pylint

app.json

@@ -1,56 +1,42 @@
 {
-  "buildpacks": [
-    {
-      "url": "heroku/python"
-    }
-  ],
-  "description": "A Fully Async-based backend for Code Inbox built using FastAPI, ODMantic, MongoDB, Deta, and friends.",
-  "env": {
-    "DEBUG": {
-      "description": "This environment variable defines the debug level.`` means production. `info` to access the docs.",
-      "required": false,
-      "value": ""
+    "buildpacks": [{"url": "heroku/python"}],
+    "description": "A Fully Async-based backend for Code Inbox built using FastAPI, ODMantic, MongoDB, Deta, and friends.",
+    "env": {
+        "DEBUG": {
+            "description": "This environment variable defines the debug level.`` means production. `info` to access the docs.",
+            "required": false,
+            "value": "",
+        },
+        "CORS_ORIGINS": {
+            "description": "Comma separated urls of the deployed client.",
+            "required": true,
+        },
+        "DETA_PROJECT_KEY": {
+            "description": "The project key of your Deta account.",
+            "required": true,
+        },
+        "MONGODB_USERNAME": {
+            "description": "This is the user name you'll be creating for remote accesses.",
+            "required": true,
+        },
+        "MONGODB_PASSWORD": {
+            "description": "The corresponding password for that user.",
+            "required": true,
+        },
+        "MONGODB_HOST": {
+            "description": "Your remote MongoDB server's domain name.",
+            "required": true,
+        },
+        "MONGODB_DATABASE": {
+            "description": "The name of the database you want to access, in our case, the `shop` database.",
+            "required": false,
+            "value": "shop",
+        },
     },
-    "CORS_ORIGINS": {
-      "description": "Comma separated urls of the deployed client.",
-      "required": true
-    },
-    "DETA_PROJECT_KEY": {
-      "description": "The project key of your Deta account.",
-      "required": true
-    },
-    "MONGODB_USERNAME": {
-      "description": "This is the user name you'll be creating for remote accesses.",
-      "required": true
-    },
-    "MONGODB_PASSWORD": {
-      "description": "The corresponding password for that user.",
-      "required": true
-    },
-    "MONGODB_HOST": {
-      "description": "Your remote MongoDB server's domain name.",
-      "required": true
-    },
-    "MONGODB_DATABASE": {
-      "description": "The name of the database you want to access, in our case, the `shop` database.",
-      "required": false,
-      "value": "shop"
-    }
-  },
-  "formation": {
-    "web": {
-      "quantity": 1,
-      "size": "free"
-    }
-  },
-  "image": "heroku/python",
-  "keywords": [
-    "fastapi",
-    "mongodb",
-    "deta",
-    "api"
-  ],
-  "name": "code-inbox-server",
-  "repository": "https://github.com/wiseaidev/code-inbox-server",
-  "success_url": "/docs"
+    "formation": {"web": {"quantity": 1, "size": "free"}},
+    "image": "heroku/python",
+    "keywords": ["fastapi", "mongodb", "deta", "api"],
+    "name": "code-inbox-server",
+    "repository": "https://github.com/wiseaidev/code-inbox-server",
+    "success_url": "/docs",
 }

poetry.lock

@@ -37,6 +37,17 @@ apscheduler = "^3.10.4"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^7.2.0"
+flake8 = "^6.1.0"
+coverage = "^7.3.1"
+mypy = "^1.5.1"
+pytest-cov = "^4.1.0"
+tox = "^4.11.3"
+isort = "^5.12.0"
+black = "^23.9.1"
+pre-commit = "^3.4.0"
+httpx = "^0.25.0"
+pylint = "^2.17.6"
+autoflake = "^2.2.1"
 
 [build-system]
 requires = ["poetry-core"]

pyproject.toml

@@ -8,11 +8,11 @@
     users,
     utils,
 )
-
 from src.main import (
     get_app,
-    serve
+    serve,
 )
+
 __author__ = """Mahmoud Harmouch"""
 __email__ = "oss@wiseai.com"
 __version__ = "0.1.0"

src/__init__.py

@@ -49,13 +49,13 @@ class Settings(BaseSettings):
     DEBUG: str = os.getenv("DEBUG")  # type: ignore
     CORS_ORIGINS: str = os.getenv("CORS_ORIGINS")  # type: ignore
     DETA_PROJECT_KEY: str = os.getenv("DETA_PROJECT_KEY")  # type: ignore
-    NYLAS_CLIENT_ID: str = os.getenv("NYLAS_CLIENT_ID")
-    NYLAS_CLIENT_SECRET: str = os.getenv("NYLAS_CLIENT_SECRET")
-    NYLAS_API_SERVER: str = os.getenv("NYLAS_API_SERVER")
-    CLIENT_URI: str = os.getenv("CLIENT_URI")
-    NYLAS_SYSTEM_TOKEN: str = os.getenv("NYLAS_SYSTEM_TOKEN")
-    OPENAI_API_KEY: str = os.getenv("OPENAI_API_KEY")
-    
+    NYLAS_CLIENT_ID: str = os.getenv("NYLAS_CLIENT_ID")  # type: ignore
+    NYLAS_CLIENT_SECRET: str = os.getenv("NYLAS_CLIENT_SECRET")  # type: ignore
+    NYLAS_API_SERVER: str = os.getenv("NYLAS_API_SERVER")  # type: ignore
+    CLIENT_URI: str = os.getenv("CLIENT_URI")  # type: ignore
+    NYLAS_SYSTEM_TOKEN: str = os.getenv("NYLAS_SYSTEM_TOKEN")  # type: ignore
+    OPENAI_API_KEY: str = os.getenv("OPENAI_API_KEY")  # type: ignore
+
     class Config:  # pylint: disable=R0903
         """
         A class used to set Pydantic configuration for env vars.

src/config.py

@@ -11,16 +11,16 @@
 )
 import logging
 from typing import (
-    Any,
     Dict,
 )
 import uvicorn
-from src.nylas import (
-    router as nylas_router,
-)
+
 from src.config import (
     settings,
 )
+from src.nylas import (
+    router as nylas_router,
+)
 from src.users import (
     router as users_router,
 )
@@ -108,8 +108,10 @@ async def root() -> Dict[str, str]:
 
     return app
 
+
 code_app = get_app()
 
+
 def serve() -> None:
     """
     A method that run a uvicorn command.
@@ -125,6 +127,7 @@ def serve() -> None:
     except Exception as err:
         logger.error(repr(err))
 
+
 __all__ = [
     "serve",
     "code_app",

src/main.py

@@ -3,10 +3,10 @@
 """
 
 from src.nylas import (
+    crud,
+    models,
     router,
     schemas,
-    crud,
-    models
 )
 
 __all__ = ["crud", "models", "router", "schemas"]