diff --git a/src/dependencies.md b/src/dependencies.md index 3d309ef..5bd3c8d 100644 --- a/src/dependencies.md +++ b/src/dependencies.md @@ -11,6 +11,7 @@ - scour (for SVG icon processing) - requests - markdown +- Flask-Migrate ## Already Included - Certain tag definitions from bleach-allowlist, used in markdown sanitization. \ No newline at end of file diff --git a/src/migrations/README b/src/migrations/README new file mode 100644 index 0000000..0e04844 --- /dev/null +++ b/src/migrations/README @@ -0,0 +1 @@ +Single-database configuration for Flask. diff --git a/src/migrations/alembic.ini b/src/migrations/alembic.ini new file mode 100644 index 0000000..ec9d45c --- /dev/null +++ b/src/migrations/alembic.ini @@ -0,0 +1,50 @@ +# A generic, single database configuration. + +[alembic] +# template used to generate migration files +# file_template = %%(rev)s_%%(slug)s + +# set to 'true' to run the environment during +# the 'revision' command, regardless of autogenerate +# revision_environment = false + + +# Logging configuration +[loggers] +keys = root,sqlalchemy,alembic,flask_migrate + +[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 + +[logger_flask_migrate] +level = INFO +handlers = +qualname = flask_migrate + +[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 diff --git a/src/migrations/env.py b/src/migrations/env.py new file mode 100644 index 0000000..4c97092 --- /dev/null +++ b/src/migrations/env.py @@ -0,0 +1,113 @@ +import logging +from logging.config import fileConfig + +from flask import current_app + +from alembic import context + +# 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. +fileConfig(config.config_file_name) +logger = logging.getLogger('alembic.env') + + +def get_engine(): + try: + # this works with Flask-SQLAlchemy<3 and Alchemical + return current_app.extensions['migrate'].db.get_engine() + except (TypeError, AttributeError): + # this works with Flask-SQLAlchemy>=3 + return current_app.extensions['migrate'].db.engine + + +def get_engine_url(): + try: + return get_engine().url.render_as_string(hide_password=False).replace( + '%', '%%') + except AttributeError: + return str(get_engine().url).replace('%', '%%') + + +# add your model's MetaData object here +# for 'autogenerate' support +# from myapp import mymodel +# target_metadata = mymodel.Base.metadata +config.set_main_option('sqlalchemy.url', get_engine_url()) +target_db = current_app.extensions['migrate'].db + +# 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 get_metadata(): + if hasattr(target_db, 'metadatas'): + return target_db.metadatas[None] + return target_db.metadata + + +def run_migrations_offline(): + """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=get_metadata(), literal_binds=True + ) + + with context.begin_transaction(): + context.run_migrations() + + +def run_migrations_online(): + """Run migrations in 'online' mode. + + In this scenario we need to create an Engine + and associate a connection with the context. + + """ + + # this callback is used to prevent an auto-migration from being generated + # when there are no changes to the schema + # reference: http://alembic.zzzcomputing.com/en/latest/cookbook.html + def process_revision_directives(context, revision, directives): + if getattr(config.cmd_opts, 'autogenerate', False): + script = directives[0] + if script.upgrade_ops.is_empty(): + directives[:] = [] + logger.info('No changes in schema detected.') + + conf_args = current_app.extensions['migrate'].configure_args + if conf_args.get("process_revision_directives") is None: + conf_args["process_revision_directives"] = process_revision_directives + + connectable = get_engine() + + with connectable.connect() as connection: + context.configure( + connection=connection, + target_metadata=get_metadata(), + **conf_args + ) + + with context.begin_transaction(): + context.run_migrations() + + +if context.is_offline_mode(): + run_migrations_offline() +else: + run_migrations_online() diff --git a/src/migrations/script.py.mako b/src/migrations/script.py.mako new file mode 100644 index 0000000..2c01563 --- /dev/null +++ b/src/migrations/script.py.mako @@ -0,0 +1,24 @@ +"""${message} + +Revision ID: ${up_revision} +Revises: ${down_revision | comma,n} +Create Date: ${create_date} + +""" +from alembic import op +import sqlalchemy as sa +${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(): + ${upgrades if upgrades else "pass"} + + +def downgrade(): + ${downgrades if downgrades else "pass"} diff --git a/src/migrations/versions/945140c35257_add_completed_key.py b/src/migrations/versions/945140c35257_add_completed_key.py new file mode 100644 index 0000000..6d3a48b --- /dev/null +++ b/src/migrations/versions/945140c35257_add_completed_key.py @@ -0,0 +1,32 @@ +"""Add completed key + +Revision ID: 945140c35257 +Revises: +Create Date: 2025-11-22 04:00:58.091124 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '945140c35257' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + with op.batch_alter_table('task', schema=None) as batch_op: + batch_op.add_column(sa.Column('completed', sa.DateTime(), nullable=True)) + + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + with op.batch_alter_table('task', schema=None) as batch_op: + batch_op.drop_column('completed') + + # ### end Alembic commands ### diff --git a/src/taskflower/__init__.py b/src/taskflower/__init__.py index c8f8b7d..828b0f5 100644 --- a/src/taskflower/__init__.py +++ b/src/taskflower/__init__.py @@ -1,6 +1,7 @@ import logging from typing import Any from flask import Flask, render_template, url_for +from flask_migrate import Migrate from taskflower.auth import taskflower_login_manager from taskflower.config import SignUpMode, config @@ -32,6 +33,7 @@ taskflower_login_manager.init_app(app) # pyright:ignore[reportUnknownMemberType] log.info(' > Initializing database...') db.init_app(app) +migrate = Migrate(app, db) log.info(' > Building routes...') diff --git a/src/taskflower/db/model/task.py b/src/taskflower/db/model/task.py index 4a7122e..8fc3be4 100644 --- a/src/taskflower/db/model/task.py +++ b/src/taskflower/db/model/task.py @@ -14,5 +14,6 @@ class Task(db.Model): due: Mapped[datetime] = mapped_column(DateTime(timezone=False)) created: Mapped[datetime] = mapped_column(DateTime(timezone=False), default=now) complete: Mapped[bool] = mapped_column(Boolean, default=False) + completed: Mapped[int] = mapped_column(DateTime(timezone=False), nullable=True) namespace: Mapped[int] = mapped_column(Integer, ForeignKey('namespace.id', ondelete='CASCADE')) owner: Mapped[int] = mapped_column(Integer, ForeignKey('user.id', ondelete='CASCADE')) \ No newline at end of file