Merge pull request #4 from mbrignone/docker_compose

Docker Compose and Alembic

.env.example

@@ -0,0 +1,13 @@
+PROJECT_NAME=
+ENVIRONMENT=
+
+USE_SQLITE=
+USE_ALEMBIC=
+ECHO_SQL=
+
+DB_BASE=
+POSTGRES_USER=
+POSTGRES_PASSWORD=
+POSTGRES_DB=
+POSTGRES_SERVER=
+POSTGRES_PORT=

Dockerfile

@@ -0,0 +1,32 @@
+# start from the official Python 3.11 image
+FROM python:3.11
+
+# set current working directory to /code
+WORKDIR /code
+
+# install Poetry
+RUN pip install "poetry==1.6.1"
+
+# copy only the requirements files (to take advantage of Docker cache)
+COPY ./pyproject.toml /code/pyproject.toml
+COPY ./poetry.lock /code/poetry.lock
+
+# install dependencies
+RUN poetry install
+RUN poetry self add 'poethepoet[poetry_plugin]'
+
+# copy Alembic files to create/migrate DB
+COPY alembic.ini /code
+COPY alembic /code/alembic
+COPY start_server.sh /code
+
+# copy the app inside the /code directory
+COPY ./app /code/app
+
+ENV PYTHONPATH /code
+
+EXPOSE 8000
+
+# run command to start Uvicorn server
+# CMD ["poetry", "poe", "start"]
+CMD [ "/bin/bash", "start_server.sh"]

README.md

@@ -26,3 +26,41 @@ $ poetry poe precommit  # run pre-commit hooks
 More arguments can be added to the base commands, for example `poetry poe start --reload`.
 
 There are also [pre-commit hooks](https://pre-commit.com/) configured to run the [Ruff](https://github.com/astral-sh/ruff) linter and code formatter. To install them, run `pre-commit install`.
+
+## Run with Docker (SQLite)
+
+1. Set `USE_SQLITE=true` in the `.env` file.
+2. Build the image (`-t` to tag the image).
+```bash
+$ docker build -t fastapi_quiz .
+```
+3. Run the container (`-d` for detached mode to run the container in the background, `-p HOST:CONTAINER` to map the ports).
+```bash
+$ docker run -d -p 8000:8000 --name fastapi_cont fastapi_quiz
+```
+4. The app can now be accessed from http://0.0.0.0:8000 (docs at http://0.0.0.0:8000/docs).
+5. Access app logs (`-f` to follow the logs).
+```bash
+$ docker logs fastapi_cont -f
+```
+6. Stop and remove the containers.
+```bash
+$ docker stop fastapi_cont
+$ docker rm fastapi_cont
+```
+
+## Run with Docker Compose (PostgreSQL)
+1. Run docker compose (optional `--build` to rebuild the images).
+```bash
+$ docker compose up -d
+```
+2. The app can now be accessed from http://0.0.0.0:8000 (docs at http://0.0.0.0:8000/docs).  The pgAdmin platform can be accessed from http://0.0.0.0:5050, using `email=pgadmin4@pgadmin.org` and `password=admin` to login (they are defined in the `docker-compose.yml` file).
+3. Access app logs (-f to follow the logs).
+```bash
+$ docker logs fastapi_app -f # FastAPI app logs
+$ docker logs postgres_db -f # PostgreSQL logs
+```
+4. Stop and remove the containers (`-v` to also delete the volume used for PostgreSQL data).
+```bash
+$ docker compose down -v
+```

alembic.ini

@@ -0,0 +1,114 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+script_location = 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
+# 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-dateutil library that can be
+# installed by adding `alembic[tz]` to the pip requirements
+# 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 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 = 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 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

alembic/README

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

alembic/env.py

@@ -0,0 +1,98 @@
+import asyncio
+from logging.config import fileConfig
+
+from sqlalchemy import pool
+from sqlalchemy.engine import Connection
+from sqlalchemy.ext.asyncio import async_engine_from_config
+
+from alembic import context
+from app.core.settings import get_settings
+from app.models import *  # noqa: F403
+from app.models.database import Base
+
+# this is the Alembic Config object, which provides
+# access to the values within the .ini file in use.
+config = context.config
+
+# 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)
+
+# update database URL
+settings = get_settings()
+config.set_main_option("sqlalchemy.url", settings.get_db_url())
+
+# add your model's MetaData object here
+# for 'autogenerate' support
+# from myapp import mymodel
+# target_metadata = mymodel.Base.metadata
+
+# all models must have been previously imported (from app.models import *)
+target_metadata = Base.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()

alembic/script.py.mako

@@ -0,0 +1,26 @@
+"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision | comma,n}
+Create Date: ${create_date}
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+${imports if imports else ""}
+
+# revision identifiers, used by Alembic.
+revision: str = ${repr(up_revision)}
+down_revision: Union[str, None] = ${repr(down_revision)}
+branch_labels: Union[str, Sequence[str], None] = ${repr(branch_labels)}
+depends_on: Union[str, Sequence[str], None] = ${repr(depends_on)}
+
+
+def upgrade() -> None:
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade() -> None:
+    ${downgrades if downgrades else "pass"}

alembic/versions/d2e4b673963c_initial_tables_quizzes_and_questions.py

@@ -0,0 +1,51 @@
+"""Initial tables (quizzes and questions)
+
+Revision ID: d2e4b673963c
+Revises: 
+Create Date: 2023-11-26 00:32:14.892163
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision: str = 'd2e4b673963c'
+down_revision: Union[str, None] = None
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table('quizzes',
+    sa.Column('title', sa.String(length=128), nullable=False),
+    sa.Column('description', sa.String(length=512), nullable=True),
+    sa.Column('created_at', sa.DateTime(timezone=True), server_default=sa.func.current_timestamp(), nullable=False),
+    sa.Column('updated_at', sa.DateTime(timezone=True), nullable=False),
+    sa.Column('id', sa.Integer(), nullable=False),
+    sa.PrimaryKeyConstraint('id')
+    )
+    op.create_index(op.f('ix_quizzes_title'), 'quizzes', ['title'], unique=False)
+    op.create_table('questions',
+    sa.Column('quiz_id', sa.Integer(), nullable=False),
+    sa.Column('content', sa.String(length=256), nullable=False),
+    sa.Column('type', sa.String(length=64), nullable=False),
+    sa.Column('points', sa.Integer(), nullable=False),
+    sa.Column('created_at', sa.DateTime(timezone=True), server_default=sa.func.current_timestamp(), nullable=False),
+    sa.Column('updated_at', sa.DateTime(timezone=True), nullable=False),
+    sa.Column('id', sa.Integer(), nullable=False),
+    sa.ForeignKeyConstraint(['quiz_id'], ['quizzes.id'], ),
+    sa.PrimaryKeyConstraint('id')
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_table('questions')
+    op.drop_index(op.f('ix_quizzes_title'), table_name='quizzes')
+    op.drop_table('quizzes')
+    # ### end Alembic commands ###