From 2695a6d2a81df9136a65fed3cb496db355a3a23d Mon Sep 17 00:00:00 2001 From: crunk Date: Wed, 19 Jul 2023 22:30:33 +0200 Subject: [PATCH] start of a sqlitedb --- app.py | 11 ++++ deploydb.py | 20 +++++++ instance/db_goes_here_now | 0 migrations/README | 1 + migrations/alembic.ini | 50 +++++++++++++++++ migrations/env.py | 110 ++++++++++++++++++++++++++++++++++++++ migrations/script.py.mako | 24 +++++++++ postmodel.py | 16 ++++++ start.py | 5 +- 9 files changed, 236 insertions(+), 1 deletion(-) create mode 100644 deploydb.py create mode 100644 instance/db_goes_here_now 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 postmodel.py diff --git a/app.py b/app.py index ae79651..4151523 100644 --- a/app.py +++ b/app.py @@ -1,5 +1,10 @@ import flask_apscheduler from flask import Flask +from flask_migrate import Migrate +from flask_sqlalchemy import SQLAlchemy + +db = SQLAlchemy() +migrate = Migrate() def create_app(): @@ -8,4 +13,10 @@ def create_app(): scheduler.api_enabled = True scheduler.init_app(APP) scheduler.start() + APP.config["SQLALCHEMY_DATABASE_URI"] = "sqlite:///schedule.db" + APP.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False + + db.init_app(APP) + migrate.init_app(APP, db, render_as_batch=True) + return APP diff --git a/deploydb.py b/deploydb.py new file mode 100644 index 0000000..11f929f --- /dev/null +++ b/deploydb.py @@ -0,0 +1,20 @@ +def deploy(): + """Run deployment of database.""" + from flask_migrate import init, migrate, stamp, upgrade + + from app import create_app, db + # This model is required for flask_migrate to make the table + from postmodel import Post # noqa: F401 + + app = create_app() + app.app_context().push() + db.create_all() + + # migrate database to latest revision + init() + stamp() + migrate() + upgrade() + + +deploy() diff --git a/instance/db_goes_here_now b/instance/db_goes_here_now new file mode 100644 index 0000000..e69de29 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..89f80b2 --- /dev/null +++ b/migrations/env.py @@ -0,0 +1,110 @@ +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: + # 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.') + + connectable = get_engine() + + with connectable.connect() as connection: + context.configure( + connection=connection, + target_metadata=get_metadata(), + process_revision_directives=process_revision_directives, + **current_app.extensions['migrate'].configure_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/postmodel.py b/postmodel.py new file mode 100644 index 0000000..bdb672b --- /dev/null +++ b/postmodel.py @@ -0,0 +1,16 @@ +from app import db + + +class Post(db.Model): + """post model class for storing a post in crunk-scheduler database""" + + __tablename__ = "posts" + + id = db.Column(db.Integer, primary_key=True) + content = db.Column(db.String, nullable=False) + files = db.Column(db.String(300), nullable=True, unique=False) + last_updated = db.Column(db.DateTime) + scheduled_time = db.Column(db.DateTime) + + def __repr__(self): + return "" % self.id diff --git a/start.py b/start.py index dcf4feb..d362d07 100644 --- a/start.py +++ b/start.py @@ -6,11 +6,14 @@ APP = create_app() @APP.route("/") -def schedule_post(): +def index(): return "crunk-scheduler online!" + @APP.route("/schedule", methods=["POST"]) +def schedule_post(): return "post scheduled" + if __name__ == "__main__": APP.run()