Replacing Alembic by Pelican

.github/workflows/test.yml

@@ -20,7 +20,7 @@ jobs:
         run: pip install -e ".[dev]"
 
       - name: Black formatting check
-        run: black --check bot tests alembic
+        run: black --check bot tests db
 
       - name: Mypy type check
         run: mypy bot tests

bot/app.py

@@ -5,6 +5,7 @@
 import matrix
 from coloredlogs import install
 from sqlmodel import SQLModel
+from pelican import get_runner, get_registry
 
 from bot import ada
 from bot.config import BotConfig
@@ -77,6 +78,20 @@ def _load_database(config: BotConfig) -> None:
     Model.set_engine(engine)
     SQLModel.metadata.create_all(engine)
 
+    if config.is_production:
+        _run_migrations()
+
+
+def _run_migrations() -> None:
+    runner = get_runner()
+    registry = get_registry()
+
+    applied = list(runner.get_applied_versions())
+    migrations = [m for m in registry.get_all() if m.revision not in applied]
+
+    for migration in migrations:
+        runner.upgrade(migration)
+
 
 def _show_app_info(config: BotConfig) -> None:
     logger.info(

bot/cli.py

@@ -1,9 +1,11 @@
 from os import getenv
-from click import UsageError, pass_context, group, option, argument
+from click import UsageError, pass_context, group, option
+
+from pelican import use_context
+from pelican.cli import cli as pelican_cli
 
 from bot.app import start
 from bot.config import BotConfig
-from bot.migration import up_migration, down_migration
 
 DEFAULT_ENV = "development"
 CONFIG_DIR = "config"
@@ -27,26 +29,24 @@ def cli(ctx, env: str | None, config_file: str | None) -> None:
         raise UsageError("Use either --env or --config, not both.")
 
     path = config_file or resolve_config_path(env)
-    ctx.obj["config"] = BotConfig(path)
+    config = BotConfig(path)
+
+    ctx.obj["config"] = config
+    ctx.with_resource(use_context(database_url=config.database_url))
 
 
-@cli.command("start")
+@cli.command("start", help="Start the bot")
 @pass_context
 def start_command(ctx):
     config = ctx.obj["config"]
     start(config.config_file)
 
 
-@cli.command()
-@argument("revision", default="head")
-@pass_context
-def up(ctx, revision):
-    config = ctx.obj["config"]
-    up_migration(config, revision)
+@cli.group(help="Database utilities commands")
+def db():
+    pass
 
 
-@cli.command()
-@argument("revision", default="head")
-def down(ctx, revision):
-    config = ctx.obj["config"]
-    down_migration(config, revision)
+# we add each pelican command to the db group
+for cmd in pelican_cli.commands.values():
+    db.add_command(cmd)

bot/config.py

@@ -21,6 +21,10 @@ def __init__(self, config_file: str) -> None:
             "[%(asctime)s] %(programname)s %(funcName)s %(module)s %(levelname)s %(message)s"
         )
 
+    @property
+    def is_production(self) -> bool:
+        return self.environment in ["production"]
+
     @property
     def extensions(self) -> Iterator[Extension]:
         from bot import extensions