From f819153fd2307dec35fc4085b7e11bc7772675f6 Mon Sep 17 00:00:00 2001 From: HombreLaser Date: Thu, 1 Feb 2024 12:28:41 -0600 Subject: Initial commit --- .gitignore | 6 ++ config/__init__.py | 28 +++++ main.py | 24 +++++ migrations/README | 1 + migrations/alembic.ini | 50 +++++++++ migrations/env.py | 113 +++++++++++++++++++++ migrations/script.py.mako | 24 +++++ ...7a92bef47675_add_unique_constraint_to_domain.py | 32 ++++++ migrations/versions/e2f6c7622c68_add_blogs.py | 34 +++++++ requirements.txt | 5 + src/controllers/__init__.py | 3 + src/controllers/dashboard_controller.py | 7 ++ src/database/__init__.py | 33 ++++++ src/database/models/__init__.py | 1 + src/database/models/blog.py | 13 +++ 15 files changed, 374 insertions(+) create mode 100644 .gitignore create mode 100644 config/__init__.py create mode 100644 main.py create mode 100644 migrations/README create mode 100644 migrations/alembic.ini create mode 100644 migrations/env.py create mode 100644 migrations/script.py.mako create mode 100644 migrations/versions/7a92bef47675_add_unique_constraint_to_domain.py create mode 100644 migrations/versions/e2f6c7622c68_add_blogs.py create mode 100644 requirements.txt create mode 100644 src/controllers/__init__.py create mode 100644 src/controllers/dashboard_controller.py create mode 100644 src/database/__init__.py create mode 100644 src/database/models/__init__.py create mode 100644 src/database/models/blog.py diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..19841c4 --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +*~ +env/ +uml/ +config.toml +__pycache__/ +*.org \ No newline at end of file diff --git a/config/__init__.py b/config/__init__.py new file mode 100644 index 0000000..b3819b8 --- /dev/null +++ b/config/__init__.py @@ -0,0 +1,28 @@ +import tomllib +from sqlalchemy.exc import IntegrityError +from src.database import db +from src.database.models.blog import Blog + +with open('config.toml', 'rb') as config_file: + user_config = tomllib.load(config_file) + +def database_connection_string(app): + if app.debug: + return (f"mysql+pymysql://{user_config['Database']['user']}:" + f"{user_config['Database']['password']}@" + f"{user_config['Database']['host']}/dev_simple_comments") + else: + return (f"mysql+pymysql://{user_config['Database']['user']}:" + f"{user_config['Database']['password']}@" + f"{user_config['Database']['host']}/simple_comments") + +def initialize_blogs(app): + with app.app_context(): + for domain in user_config['Blogs']['domains']: + blog = Blog(domain=domain) + db.session.add(blog) + try: + db.session.commit() + except IntegrityError: + db.session.rollback() + continue diff --git a/main.py b/main.py new file mode 100644 index 0000000..5a585f0 --- /dev/null +++ b/main.py @@ -0,0 +1,24 @@ +from flask import Flask +from flask_migrate import Migrate +from src.database import db, init_db +from src.controllers.dashboard_controller import dashboard_blueprint +import config + +app = Flask(__name__) +app.config['SQLALCHEMY_DATABASE_URI'] = config.database_connection_string(app) + +init_db(app) + +# Blueprints registration +app.register_blueprint(dashboard_blueprint) + +# Check the config file for any blog domains +config.initialize_blogs(app) + +if app.debug == 'development': + # Shell mode + @app.shell_context_processor + def shell(): + return { + "db": db + } diff --git a/migrations/README b/migrations/README new file mode 100644 index 0000000..0e04844 --- /dev/null +++ b/migrations/README @@ -0,0 +1 @@ +Single-database configuration for Flask. diff --git a/migrations/alembic.ini b/migrations/alembic.ini new file mode 100644 index 0000000..ec9d45c --- /dev/null +++ b/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/migrations/env.py b/migrations/env.py new file mode 100644 index 0000000..4c97092 --- /dev/null +++ b/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/migrations/script.py.mako b/migrations/script.py.mako new file mode 100644 index 0000000..2c01563 --- /dev/null +++ b/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/migrations/versions/7a92bef47675_add_unique_constraint_to_domain.py b/migrations/versions/7a92bef47675_add_unique_constraint_to_domain.py new file mode 100644 index 0000000..c915ab5 --- /dev/null +++ b/migrations/versions/7a92bef47675_add_unique_constraint_to_domain.py @@ -0,0 +1,32 @@ +"""Add unique constraint to domain + +Revision ID: 7a92bef47675 +Revises: e2f6c7622c68 +Create Date: 2024-02-01 12:16:13.397739 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '7a92bef47675' +down_revision = 'e2f6c7622c68' +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + with op.batch_alter_table('blogs', schema=None) as batch_op: + batch_op.create_unique_constraint(None, ['domain']) + + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + with op.batch_alter_table('blogs', schema=None) as batch_op: + batch_op.drop_constraint(None, type_='unique') + + # ### end Alembic commands ### diff --git a/migrations/versions/e2f6c7622c68_add_blogs.py b/migrations/versions/e2f6c7622c68_add_blogs.py new file mode 100644 index 0000000..9c76d5d --- /dev/null +++ b/migrations/versions/e2f6c7622c68_add_blogs.py @@ -0,0 +1,34 @@ +"""Add Blogs + +Revision ID: e2f6c7622c68 +Revises: +Create Date: 2024-02-01 11:58:22.590819 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'e2f6c7622c68' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('blogs', + sa.Column('id', sa.BigInteger(), nullable=False), + sa.Column('domain', sa.String(length=255), nullable=False), + sa.Column('created_at', sa.DateTime(), nullable=True), + sa.Column('updated_at', sa.DateTime(), nullable=True), + sa.PrimaryKeyConstraint('id') + ) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('blogs') + # ### end Alembic commands ### diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..a963528 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,5 @@ +Flask +Flask-Migrate +Flask-SQLAlchemy +PyMySQL +scrypt diff --git a/src/controllers/__init__.py b/src/controllers/__init__.py new file mode 100644 index 0000000..d9ad692 --- /dev/null +++ b/src/controllers/__init__.py @@ -0,0 +1,3 @@ +from flask import Blueprint, current_app + +dashboard_blueprint = Blueprint('dashboard_controller', '__dashboard_controller__') diff --git a/src/controllers/dashboard_controller.py b/src/controllers/dashboard_controller.py new file mode 100644 index 0000000..888e388 --- /dev/null +++ b/src/controllers/dashboard_controller.py @@ -0,0 +1,7 @@ +from flask import Blueprint +from src.controllers import dashboard_blueprint +from src.database.models.blog import Blog + +@dashboard_blueprint.get('/dashboard') +def index(): + return '

Hello, world!

' diff --git a/src/database/__init__.py b/src/database/__init__.py new file mode 100644 index 0000000..c1e2295 --- /dev/null +++ b/src/database/__init__.py @@ -0,0 +1,33 @@ +from datetime import datetime, timezone +from flask_migrate import Migrate +from flask_sqlalchemy import SQLAlchemy +from sqlalchemy.orm import DeclarativeBase, MappedAsDataclass, Mapper +from sqlalchemy import event, update + +class Base(DeclarativeBase, MappedAsDataclass): + pass + +db = SQLAlchemy(model_class=Base) + +def init_db(app): + migrate = Migrate(app, db) + db.init_app(app) + +@event.listens_for(Mapper, 'after_insert') +def insert_created_and_updated_at_columns(mapper, connection, target): + set_timestamps = ( + update(mapper.local_table). + where(mapper.local_table.c.id == target.id). + values(created_at=datetime.now(timezone.utc), + updated_at=datetime.now(timezone.utc)) + ) + connection.execute(set_timestamps) + +@event.listens_for(Mapper, 'before_update') +def set_updated_at_timestamp(mapper, connection, target): + set_updated_at = ( + update(mapper.local_table). + where(mapper.local_table.c.id == target.id). + values(updated_at=datetime.now(timezone.utc)) + ) + connection.execute(set_updated_at) diff --git a/src/database/models/__init__.py b/src/database/models/__init__.py new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/src/database/models/__init__.py @@ -0,0 +1 @@ + diff --git a/src/database/models/blog.py b/src/database/models/blog.py new file mode 100644 index 0000000..6a0fb42 --- /dev/null +++ b/src/database/models/blog.py @@ -0,0 +1,13 @@ +import datetime +from sqlalchemy import BigInteger, String, DateTime +from sqlalchemy.orm import mapped_column, Mapped +from src.database import db + + +class Blog(db.Model): + __tablename__ = 'blogs' + + id = mapped_column(BigInteger, primary_key=True) + domain: Mapped[str] = mapped_column(String(255), nullable=False, unique=True) + created_at = mapped_column(DateTime) + updated_at = mapped_column(DateTime) -- cgit v1.2.3