Init

TODO
- Alembic autogenerate configure
- Test codes

Author: teamhide

.gitignore

@@ -0,0 +1,2 @@
+.idea/
+__pycache__/

Pipfile

@@ -0,0 +1,16 @@
+[[source]]
+name = "pypi"
+url = "https://pypi.org/simple"
+verify_ssl = true
+
+[dev-packages]
+
+[packages]
+fastapi = "*"
+alembic = "*"
+sqlalchemy = "*"
+uvicorn = "*"
+pyjwt = "*"
+
+[requires]
+python_version = "3.8"

Pipfile.lock

@@ -0,0 +1,4 @@
+# FastAPI Boilerplate
+
+- FastAPI
+- SQLAlchemy

README.md

@@ -0,0 +1,85 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+script_location = migrations
+
+# template used to generate migration files
+# file_template = %%(rev)s_%%(slug)s
+
+# timezone to use when rendering the date
+# within the migration file as well as the filename.
+# string value is passed to dateutil.tz.gettz()
+# leave blank for localtime
+# timezone =
+
+# max length of characters to apply to the
+# "slug" field
+# truncate_slug_length = 40
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+# set to 'true' to allow .pyc and .pyo files without
+# a source .py file to be detected as revisions in the
+# versions/ directory
+# sourceless = false
+
+# version location specification; this defaults
+# to migrations/versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path
+# version_locations = %(here)s/bar %(here)s/bat migrations/versions
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+sqlalchemy.url = driver://user:pass@localhost/dbname
+
+
+[post_write_hooks]
+# post_write_hooks defines scripts or Python functions that are run
+# on newly generated revision scripts.  See the documentation for further
+# detail and examples
+
+# format using "black" - use the console_scripts runner, against the "black" entrypoint
+# hooks=black
+# black.type=console_scripts
+# black.entrypoint=black
+# black.options=-l 79
+
+# Logging configuration
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARN
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARN
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

alembic.ini

@@ -0,0 +1,58 @@
+from fastapi import FastAPI, Request
+from fastapi.middleware.cors import CORSMiddleware
+from fastapi.responses import JSONResponse
+
+from app.views import home_router
+from app.views.v1 import user_router
+from core.config import get_config
+from core.db import session
+from core.exception import CustomException
+
+
+def init_cors(app: FastAPI) -> None:
+    app.add_middleware(
+        CORSMiddleware,
+        allow_origins=['*'],
+        allow_credentials=True,
+        allow_methods=['*'],
+        allow_headers=['*'],
+    )
+
+
+def init_routers(app: FastAPI) -> None:
+    app.include_router(home_router)
+    app.include_router(user_router, prefix='/api/v1', tags=['User'])
+
+
+def init_listeners(app: FastAPI) -> None:
+    # Exception handler
+    @app.exception_handler(CustomException)
+    async def custom_exception_handler(request: Request, exc: CustomException):
+        return JSONResponse(
+            status_code=exc.code,
+            content=exc.kwargs,
+        )
+
+    # Middleware for SQLAlchemy session
+    @app.middleware('http')
+    async def remove_session(request: Request, call_next):
+        response = await call_next(request)
+        session.remove()
+        return response
+
+
+def create_app() -> FastAPI:
+    app = FastAPI(
+        title='Hide',
+        description='Hide API',
+        version='1.0.0',
+        docs_url=None if get_config().ENV == 'production' else '/docs',
+        redoc_url=None if get_config().ENV == 'production' else '/redoc',
+    )
+    init_routers(app=app)
+    init_cors(app=app)
+    init_listeners(app=app)
+    return app
+
+
+app = create_app()