diff --git a/dyxless/__init__.py b/dyxless/__init__.py index 54295be..b5dc45f 100644 --- a/dyxless/__init__.py +++ b/dyxless/__init__.py @@ -1,9 +1,9 @@ -import os import json from flask import Flask from flask_mail import Mail from flask_sqlalchemy import SQLAlchemy +from flask_migrate import Migrate from flask_login import LoginManager app = Flask( @@ -12,6 +12,7 @@ app = Flask( static_folder="dyxless/static", ) db = SQLAlchemy() +migrate = Migrate(app, db) mail = Mail() with open("dyxless/config.json") as config_file: @@ -59,6 +60,3 @@ app.register_blueprint(main_blueprint) from .mails import mails as mails_blueprint app.register_blueprint(mails_blueprint) - -if not os.path.exists(app.config["SQLALCHEMY_DATABASE_URI"]): - db.create_all(app=app) diff --git a/dyxless/config.json_template b/dyxless/config.json_template index 461964b..9bbca28 100644 --- a/dyxless/config.json_template +++ b/dyxless/config.json_template @@ -7,7 +7,7 @@ "APP_EMAIL": "appsender@gmail.com }, "db_settings": { - "SQLALCHEMY_DATABASE_URI": "sqlite:///db.sqlite" + "SQLALCHEMY_DATABASE_URI": "postgresql://ownername:pass@localhost/dyxless" }, "mail_settings": { "MAIL_SERVER": "smtp.gmail.com", 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..68feded --- /dev/null +++ b/migrations/env.py @@ -0,0 +1,91 @@ +from __future__ import with_statement + +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') + +# 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', + str(current_app.extensions['migrate'].db.get_engine().url).replace( + '%', '%%')) +target_metadata = current_app.extensions['migrate'].db.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(): + """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=target_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 = current_app.extensions['migrate'].db.get_engine() + + with connectable.connect() as connection: + context.configure( + connection=connection, + target_metadata=target_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/migrations/versions/3ca17c6fd061_.py b/migrations/versions/3ca17c6fd061_.py new file mode 100644 index 0000000..698f449 --- /dev/null +++ b/migrations/versions/3ca17c6fd061_.py @@ -0,0 +1,40 @@ +"""empty message + +Revision ID: 3ca17c6fd061 +Revises: +Create Date: 2021-08-18 19:13:48.248213 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '3ca17c6fd061' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('users', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('email', sa.String(), nullable=False), + sa.Column('password', sa.String(), nullable=False), + sa.Column('username', sa.String(), nullable=False), + sa.Column('registered_on', sa.DateTime(), nullable=False), + sa.Column('last_login', sa.DateTime(), nullable=True), + sa.Column('is_confirmed', sa.Boolean(), nullable=False), + sa.Column('is_admin', sa.Boolean(), nullable=False), + sa.PrimaryKeyConstraint('id'), + sa.UniqueConstraint('email'), + sa.UniqueConstraint('username') + ) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('users') + # ### end Alembic commands ### diff --git a/runscripts/postgres/createdb.sh b/runscripts/postgres/createdb.sh new file mode 100644 index 0000000..33065b4 --- /dev/null +++ b/runscripts/postgres/createdb.sh @@ -0,0 +1,11 @@ +sudo -u postgres psql + +CREATE DATABASE dyxless; + +CREATE ROLE dyxless; + +ALTER USER dyxless WITH PASSWORD 'password'; + +ALTER ROLE "dyxless" WITH LOGIN; + +ALTER DATABASE dyxless OWNER TO dyxless; \ No newline at end of file diff --git a/runscripts/postgres/initdb.bat b/runscripts/postgres/initdb.bat new file mode 100644 index 0000000..8353bff --- /dev/null +++ b/runscripts/postgres/initdb.bat @@ -0,0 +1,8 @@ + +@echo off + +set FLASK_APP=dyxless + +flask db init +flask db migrate +flask db upgrade diff --git a/runscripts/postgres/initdb.sh b/runscripts/postgres/initdb.sh new file mode 100644 index 0000000..e6b50ac --- /dev/null +++ b/runscripts/postgres/initdb.sh @@ -0,0 +1,7 @@ +set echo off + +export FLASK_APP=dyxless + +flask db init +flask db migrate +flask db upgrade