formatting with pre commit

Author: rohit.jadhav1

.env.example

@@ -6,4 +6,4 @@ GITHUB_CLIENT_ID=[GITHUB_CLIENT_ID]
 GITHUB_CLIENT_SECRET=[GITHUB_CLIENT_SECRET]
 INTERNAL_AUTH_TOKEN='[INTERNAL_AUTH_TOKEN]'
 SUPERTOKENS_API_KEY='[SUPERTOKENS_API_KEY]'
-SUPERTOKENS_CONNECTION_URI='[SUPERTOKENS_CONNECTION_URI]'
+SUPERTOKENS_CONNECTION_URI='[SUPERTOKENS_CONNECTION_URI]'

.gitignore

@@ -32,4 +32,4 @@ next-env.d.ts
 
 # python
 __pycache__
-.mypy_cache
+.mypy_cache

.pre-commit-config.yaml

@@ -0,0 +1,10 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/psf/black
+    rev: 23.3.0
+    hooks:
+      - id: black

Makefile

@@ -30,4 +30,4 @@ rollback_base:
 		alembic downgrade base
 
 reset:
-		make rollback migrate seed
+		make rollback migrate seed

README.md

@@ -73,6 +73,21 @@ The project is organized into the following directories and files:
 4. Rename `.env.example` to `.env` and fill in the values
 5. Run `make server` and `make worker` to start the web server and the Celery worker
 
+
+## Pre-Commit Setup
+
+If you are using this project then pre-commit setup would be very helpful for checking your codebase. In short, pre-commit is a tool that allows developers to define and apply automated checks to their code before they commit it to a version control system. You can find more info [here](https://pre-commit.com)
+
+
+```commandline
+pip install pre-commit
+pre-commit --version
+pre-commit install
+
+# for the first time, run on all files
+pre-commit run --all-files
+```
+
 ## License
 
 MIT License

alembic.ini

@@ -134,4 +134,4 @@ class = logging.Formatter
 class = app.utils.RichConsoleHandler
 args = (100, "blue")
 kwargs = {"omit_repeated_times":False, "show_time": False, "enable_link_path": True, "tracebacks_show_locals": True}
-level = NOTSET
+level = NOTSET

app/celery.py

@@ -1,5 +1,5 @@
-from celery import Celery # type: ignore
-from kombu.utils.url import safequote # type: ignore
+from celery import Celery  # type: ignore
+from kombu.utils.url import safequote  # type: ignore
 from app import config
 
 settings = config.get_settings()

app/db/README

@@ -1 +1 @@
-Generic single-database configuration.
+Generic single-database configuration.

app/db/versions/2023_04_03_1551-184d20e99b62_create_initial_tables.py

@@ -1,7 +1,7 @@
 """create initial tables
 
 Revision ID: 184d20e99b62
-Revises: 
+Revises:
 Create Date: 2023-03-31 19:31:13.839153
 
 """

app/models/event_documentation.py

@@ -54,5 +54,6 @@ class EventDocumentationCreate(PydanticModelBase):
     domains: List[str]
     paths: List[str]
 
+
 class EventDocumentationUpdate(PydanticModelBase):
-    last_seen: datetime
+    last_seen: datetime

app/services/__init__.py

@@ -2,4 +2,4 @@
 from .event import *
 from .domain import *
 from .user import *
-from .event_documentation import *
+from .event_documentation import *

app/services/base.py

@@ -1,10 +1,11 @@
 from sqlalchemy.ext.asyncio import AsyncSession
 from pydantic import UUID4
 
+
 class BaseService:
     account_id: UUID4
     db: AsyncSession
-    
+
     def __init__(self, db: AsyncSession, account_id: UUID4):
         self.account_id = account_id
-        self.db = db
+        self.db = db

app/subapps/__init__.py

@@ -1,3 +1,3 @@
 from .client import *
 from .web_app import *
-from .internal import *
+from .internal import *

app/utils/__init__.py

@@ -1,3 +1,2 @@
 from .logger import *
 from .route_handler import *
-

mypy.ini

@@ -10,4 +10,4 @@ warn_required_dynamic_aliases = True
 warn_untyped_fields = True
 
 [mypy-supertokens_python.*]
-follow_imports = skip
+follow_imports = skip

requirements/common.txt

@@ -12,4 +12,4 @@ rich
 supertokens-python
 requests
 boto3
-celery[sqs]
+celery[sqs]

requirements/dev.txt

@@ -7,4 +7,4 @@ types-Pygments
 types-psycopg2
 types-python-dateutil
 types-ujson
-boto3-stubs[s3]
+boto3-stubs[s3]