Add default models and Alembic (#12)

* [#9] feat: add default models, alembic, example bot/package; infra: tweak GHA

* [#9] fix: missing env vars

* [#9] chore: update packages and pg_client

Author: nickatnight

.env_example

@@ -22,3 +22,7 @@ DOMAIN_LIST=
 # Redis
 REDIS_HOST=redis
 REDIS_PORT=6379
+
+# Misc
+CLIENT_ID=
+CLIENT_SECRET=

.github/workflows/main.yml

@@ -34,7 +34,7 @@ jobs:
         working-directory: ./backend
         run: |
           pip install black==22.6.0
-          black --check --config=pyproject.toml .
+          black --check .
 
   isort:
     runs-on: ubuntu-20.04
@@ -50,7 +50,7 @@ jobs:
         working-directory: ./backend
         run: |
           pip install isort==5.10.1
-          isort --settings-path=pyproject.toml src
+          isort src
 
   create-release:
     needs: [linter, black, isort]

Makefile

@@ -15,6 +15,7 @@ RUN apk add --no-cache \
     gcc \
     libffi-dev \
     g++ \
+    git \
     musl-dev &&\
     pip3 install --upgrade pip &&\
     rm -rf /tmp/*

backend/Dockerfile

@@ -0,0 +1,103 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+script_location = migrations
+
+# 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 migrations/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:migrations/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.
+
+# 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
+
+# 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

backend/alembic.ini

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

backend/migrations/README

@@ -0,0 +1,98 @@
+import asyncio
+import pathlib
+import sys
+from logging.config import fileConfig
+
+from alembic import context
+from sqlalchemy import create_engine
+from sqlalchemy.engine import Connection
+from sqlalchemy.ext.asyncio import AsyncEngine
+from sqlmodel import SQLModel
+
+
+sys.path.append(str(pathlib.Path(__file__).resolve().parents[1]))
+
+from src.db.utils import get_db_url  # noqa
+from src.models import *  # noqa
+
+
+POSTGRES_URL = get_db_url()
+
+# 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)
+
+# add your model's MetaData object here
+# for 'autogenerate' support
+# from myapp import mymodel
+# target_metadata = mymodel.Base.metadata
+target_metadata = SQLModel.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.
+
+    """
+    context.configure(
+        url=POSTGRES_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_migrations_online() -> None:
+    """Run migrations in 'online' mode.
+
+    In this scenario we need to create an Engine
+    and associate a connection with the context.
+
+    """
+    # connectable = AsyncEngine(
+    #     engine_from_config(
+    #         config.get_section(config.config_ini_section),
+    #         prefix="sqlalchemy.",
+    #         poolclass=pool.NullPool,
+    #         future=True,
+    #     )
+    # )
+    connectable = AsyncEngine(create_engine(POSTGRES_URL, echo=True, future=True))
+
+    async with connectable.connect() as connection:
+        await connection.run_sync(do_run_migrations)
+
+    await connectable.dispose()
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    asyncio.run(run_migrations_online())

backend/migrations/env.py

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

backend/migrations/script.py.mako

@@ -0,0 +1,43 @@
+"""init
+
+Revision ID: d7effbf2730a
+Revises:
+Create Date: 2022-09-03 07:30:33.398069
+
+"""
+import sqlalchemy as sa
+import sqlmodel
+from alembic import op
+
+
+# revision identifiers, used by Alembic.
+revision = "d7effbf2730a"
+down_revision = None
+branch_labels = None
+depends_on = None
+
+
+def upgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table(
+        "meme",
+        sa.Column("updated_at", sa.DateTime(timezone=True), nullable=True),
+        sa.Column("created_at", sa.DateTime(timezone=True), nullable=True),
+        sa.Column("timestamp", sa.DateTime(timezone=True), nullable=False),
+        sa.Column("submission_id", sqlmodel.sql.sqltypes.AutoString(), nullable=False),
+        sa.Column("submission_url", sqlmodel.sql.sqltypes.AutoString(), nullable=False),
+        sa.Column("submission_title", sqlmodel.sql.sqltypes.AutoString(), nullable=False),
+        sa.Column("permalink", sqlmodel.sql.sqltypes.AutoString(), nullable=False),
+        sa.Column("author", sqlmodel.sql.sqltypes.AutoString(), nullable=False),
+        sa.Column("id", sqlmodel.sql.sqltypes.GUID(), nullable=False),
+        sa.PrimaryKeyConstraint("id"),
+    )
+    op.create_index(op.f("ix_meme_id"), "meme", ["id"], unique=False)
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_index(op.f("ix_meme_id"), table_name="meme")
+    op.drop_table("meme")
+    # ### end Alembic commands ###

backend/migrations/versions/d7effbf2730a_init.py

@@ -1,12 +1,15 @@
-# api
-fastapi==0.81.0
-uvicorn==0.18.3
+
+# utils
+aioredis==2.0.1
+alembic==1.8.1
 
 # database
 asyncpg==0.26.0
-sqlmodel==0.0.7
-psycopg2-binary==2.9.3
 
-# utils
-aioredis==2.0.1
+# api
+fastapi==0.81.0
 fastapi-limiter==0.1.4
+psycopg2-binary==2.9.3
+git+https://github.com/nickatnight/[email protected]#egg=r-dogecoin-bot
+sqlmodel==0.0.8
+uvicorn==0.18.3