Merge pull request #2 from ArielMAJ/release/0.2.0

Release/0.2.0

Author: ArielMAJ

.env.example

@@ -2,3 +2,12 @@ APPLICATION_HOST=127.0.0.1
 APPLICATION_PORT=3000
 
 APPLICATION_ROOT=
+
+POSTGRES_USER=postgres
+POSTGRES_PASSWORD=postgres
+POSTGRES_HOST=localhost
+POSTGRES_DATABASE=postgres
+POSTGRES_PORT=5432
+
+POSTGRES_ECHO=true
+DATABASE_ENABLE_CONNECTION_POOLING=true

.pre-commit-config.yaml

@@ -3,11 +3,8 @@ repos:
     rev: "1.7.0"
     hooks:
       - id: poetry-check
-        args: [--directory=backend]
       - id: poetry-lock
-        args: [--directory=backend]
       - id: poetry-install
-        args: [--directory=backend]
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.5.0
     hooks:

Makefile

@@ -3,7 +3,6 @@ ifneq ("$(wildcard .env)","")
 	export
 endif
 
-
 .PHONY: run
 run: ## Run the project.
 	poetry run python -m api
@@ -19,6 +18,30 @@ install: ## Install Python requirements.
 test: ## Run tests.
 	ENVIRONMENT=test poetry run pytest --cov
 
+.PHONY: up-database
+up-database: ## Start database container.
+	docker compose up -d postgres --force-recreate
+
+.PHONY: down
+down: ## Stop all containers.
+	docker compose down
+
+.PHONY: migrate
+migrate: ## Run database migrations.
+	poetry run alembic upgrade head
+
+.PHONY: revision
+revision: ## Create a new database migration.
+	poetry run alembic revision --autogenerate -m "$(MESSAGE)"
+
+.PHONY: docker-rm
+docker-rm: ## Remove all containers.
+	docker rm -f $$(docker ps -a -q)
+
+.PHONY: docker-rmi
+docker-rmi: ## Remove all images.
+	docker rmi -f $$(docker images -q)
+
 .PHONY: pre-commit
 pre-commit: ## Run pre-commit checks.
 	poetry run pre-commit run --config ./.pre-commit-config.yaml

alembic.ini

@@ -0,0 +1,117 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+# Use forward slashes (/) also on windows to provide an os agnostic path
+script_location = api/database/alembic
+
+# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
+# Uncomment the line below if you want the files to be prepended with date and time
+# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file
+# for all available tokens
+# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
+
+# sys.path path, will be prepended to sys.path if present.
+# defaults to the current working directory.
+prepend_sys_path = .
+
+# timezone to use when rendering the date within the migration file
+# as well as the filename.
+# If specified, requires the python>=3.9 or backports.zoneinfo library.
+# Any required deps can installed by adding `alembic[tz]` to the pip requirements
+# string value is passed to ZoneInfo()
+# 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 alembic/versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path.
+# The path separator used here should be the separator specified by "version_path_separator" below.
+# version_locations = %(here)s/bar:%(here)s/bat:alembic/versions
+
+# version path separator; As mentioned above, this is the character used to split
+# version_locations. The default within new alembic.ini files is "os", which uses os.pathsep.
+# If this key is omitted entirely, it falls back to the legacy behavior of splitting on spaces and/or commas.
+# Valid values for version_path_separator are:
+#
+# version_path_separator = :
+# version_path_separator = ;
+# version_path_separator = space
+version_path_separator = os  # Use os.pathsep. Default configuration used for new projects.
+
+# set to 'true' to search source files recursively
+# in each "version_locations" directory
+# new in Alembic version 1.10
+# recursive_version_locations = false
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+
+# sqlalchemy.url = postgresql+asyncpg://postgres:postgres@localhost:5432/postgres
+
+
+[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 REVISION_SCRIPT_FILENAME
+
+# lint with attempts to fix using "ruff" - use the exec runner, execute a binary
+# hooks = ruff
+# ruff.type = exec
+# ruff.executable = %(here)s/.venv/bin/ruff
+# ruff.options = --fix REVISION_SCRIPT_FILENAME
+
+# 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

api/app.py

@@ -1,9 +1,12 @@
 from pathlib import Path
 
+from api.config import Config
 from api.entrypoints.router import api_router
 from fastapi import FastAPI
 from fastapi.middleware.cors import CORSMiddleware
-from fastapi.responses import JSONResponse
+from fastapi_async_sqlalchemy import SQLAlchemyMiddleware
+
+# from fastapi.responses import JSONResponse
 from fastapi_cache import FastAPICache
 from fastapi_cache.backends.inmemory import InMemoryBackend
 
@@ -20,7 +23,7 @@ def get_app() -> FastAPI:
     """
     _app = FastAPI(
         title="fastapi-backend-template",
-        default_response_class=JSONResponse,
+        # default_response_class=JSONResponse,
     )
 
     _app.add_middleware(
@@ -30,6 +33,12 @@ def get_app() -> FastAPI:
         allow_methods=["*"],
         allow_headers=["*"],
     )
+    _app.add_middleware(
+        SQLAlchemyMiddleware,
+        db_url=Config.DATABASE.DB_URL,
+        engine_args=Config.DATABASE.ENGINE_ARGS,
+        commit_on_exit=True,
+    )
     _app.include_router(router=api_router)
 
     FastAPICache.init(InMemoryBackend(), prefix="fastapi-cache")

api/config.py

@@ -4,6 +4,59 @@
 
 import os
 
+from sqlalchemy import URL, AsyncAdaptedQueuePool, NullPool
+
+
+class DatabaseConfig:
+    """Database configuration."""
+
+    DATABASE_DRIVERNAME = os.getenv("DATABASE_DRIVERNAME", "postgresql+asyncpg")
+    POSTGRES_USER = os.getenv("POSTGRES_USER", "postgres")
+    POSTGRES_PASSWORD = os.getenv("POSTGRES_PASSWORD", "postgres")
+    POSTGRES_HOST = os.getenv("POSTGRES_HOST", "localhost")
+    POSTGRES_PORT = os.getenv("POSTGRES_PORT", "5432")
+    POSTGRES_DATABASE = os.getenv("POSTGRES_DATABASE", "postgres")
+    POSTGRES_URI = (
+        f"{DATABASE_DRIVERNAME}:"
+        f"//{POSTGRES_USER}:{POSTGRES_PASSWORD}"
+        f"@{POSTGRES_HOST}:{POSTGRES_PORT}/{POSTGRES_DATABASE}"
+    )
+    DB_URL = URL(
+        drivername=DATABASE_DRIVERNAME,
+        username=POSTGRES_USER,
+        password=POSTGRES_PASSWORD,
+        host=POSTGRES_HOST,
+        port=POSTGRES_PORT,
+        database=POSTGRES_DATABASE,
+        query={},
+    )
+    POSTGRES_ECHO = os.getenv("POSTGRES_ECHO", "false").lower() == "true"
+    POOL_PRE_PING = os.getenv("POOL_PRE_PING", True)
+    POOL_SIZE = int(os.getenv("POOL_SIZE", 5))
+    MAX_OVERFLOW = int(os.getenv("MAX_OVERFLOW", 10))
+
+    DATABASE_ENABLE_CONNECTION_POOLING = (
+        os.getenv("DATABASE_ENABLE_CONNECTION_POOLING", "true").lower() == "true"
+    )
+
+    _POOLING_ARGS = (
+        {
+            "poolclass": AsyncAdaptedQueuePool,
+            "pool_size": POOL_SIZE,
+            "max_overflow": MAX_OVERFLOW,
+        }
+        if DATABASE_ENABLE_CONNECTION_POOLING
+        else {
+            "poolclass": NullPool,
+        }
+    )
+
+    ENGINE_ARGS = {
+        "echo": POSTGRES_ECHO,
+        "pool_pre_ping": POOL_PRE_PING,
+        **_POOLING_ARGS,
+    }
+
 
 class Config:
     """Base configuration."""
@@ -20,6 +73,8 @@ class Config:
 
     APPLICATION_ROOT = os.getenv("APPLICATION_ROOT", "")
 
+    DATABASE: DatabaseConfig = DatabaseConfig()
+
 
 class TestConfig(Config):
     """Test configuration."""

api/database/__init__.py

@@ -0,0 +1 @@
+from api.database.models import users  # noqa

api/database/alembic/README

@@ -0,0 +1 @@
+Generic single-database configuration with an async dbapi.

api/database/alembic/env.py

@@ -0,0 +1,92 @@
+import asyncio
+from logging.config import fileConfig
+
+from alembic import context
+from api.config import Config
+from api.database.models.model_base import ModelBase
+from sqlalchemy import pool
+from sqlalchemy.engine import Connection
+from sqlalchemy.ext.asyncio import async_engine_from_config
+
+# this is the Alembic Config object, which provides
+# access to the values within the .ini file in use.
+config = context.config
+config.set_main_option("sqlalchemy.url", Config.DATABASE.POSTGRES_URI)
+
+
+# Interpret the config file for Python logging.
+# This line sets up loggers basically.
+if config.config_file_name is not None:
+    fileConfig(config.config_file_name)
+
+# add your model's MetaData object here
+# for 'autogenerate' support
+# from myapp import mymodel
+# target_metadata = mymodel.Base.metadata
+target_metadata = ModelBase.metadata
+
+# other values from the config, defined by the needs of env.py,
+# can be acquired:
+# my_important_option = config.get_main_option("my_important_option")
+# ... etc.
+
+
+def run_migrations_offline() -> None:
+    """Run migrations in 'offline' mode.
+
+    This configures the context with just a URL
+    and not an Engine, though an Engine is acceptable
+    here as well.  By skipping the Engine creation
+    we don't even need a DBAPI to be available.
+
+    Calls to context.execute() here emit the given string to the
+    script output.
+
+    """
+    url = config.get_main_option("sqlalchemy.url")
+    context.configure(
+        url=url,
+        target_metadata=target_metadata,
+        literal_binds=True,
+        dialect_opts={"paramstyle": "named"},
+    )
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+def do_run_migrations(connection: Connection) -> None:
+    context.configure(connection=connection, target_metadata=target_metadata)
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+async def run_async_migrations() -> None:
+    """In this scenario we need to create an Engine
+    and associate a connection with the context.
+
+    """
+
+    connectable = async_engine_from_config(
+        config.get_section(config.config_ini_section, {}),
+        prefix="sqlalchemy.",
+        poolclass=pool.NullPool,
+    )
+
+    async with connectable.connect() as connection:
+        await connection.run_sync(do_run_migrations)
+
+    await connectable.dispose()
+
+
+def run_migrations_online() -> None:
+    """Run migrations in 'online' mode."""
+
+    asyncio.run(run_async_migrations())
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()