From c649f0b2cfffeb2a87679ff56664d21c9d8cbc0c Mon Sep 17 00:00:00 2001 From: Benjamyn Love Date: Wed, 8 Mar 2023 18:26:16 +1100 Subject: [PATCH] Restructure + Migrations --- .gitignore | 4 +- __pycache__/__init__.cpython-310.pyc | Bin 742 -> 0 bytes __pycache__/auth.cpython-310.pyc | Bin 673 -> 0 bytes __pycache__/main.cpython-310.pyc | Bin 542 -> 0 bytes __pycache__/models.cpython-310.pyc | Bin 500 -> 0 bytes migrations/README | 1 + migrations/alembic.ini | 50 ++++++++ migrations/env.py | 110 ++++++++++++++++++ migrations/script.py.mako | 24 ++++ __init__.py => priceybot2/__init__.py | 7 +- auth.py => priceybot2/auth.py | 0 chatbot.py => priceybot2/chatbot.py | 2 +- {config => priceybot2/config}/__init__.py | 0 {config => priceybot2/config}/db.py.sample | 0 .../config}/service-acct.json.sample | 0 main.py => priceybot2/main.py | 2 +- models.py => priceybot2/models.py | 2 + {templates => priceybot2/templates}/base.html | 0 {templates => priceybot2/templates}/home.html | 0 .../templates}/index.html | 0 .../templates}/login.html | 0 priceybot2/templates/profile.html | 9 ++ .../templates}/signup.html | 0 requirements.txt | 1 + templates/profile.html | 8 -- 25 files changed, 206 insertions(+), 14 deletions(-) delete mode 100644 __pycache__/__init__.cpython-310.pyc delete mode 100644 __pycache__/auth.cpython-310.pyc delete mode 100644 __pycache__/main.cpython-310.pyc delete mode 100644 __pycache__/models.cpython-310.pyc create mode 100644 migrations/README create mode 100644 migrations/alembic.ini create mode 100644 migrations/env.py create mode 100644 migrations/script.py.mako rename __init__.py => priceybot2/__init__.py (92%) rename auth.py => priceybot2/auth.py (100%) rename chatbot.py => priceybot2/chatbot.py (98%) rename {config => priceybot2/config}/__init__.py (100%) rename {config => priceybot2/config}/db.py.sample (100%) rename {config => priceybot2/config}/service-acct.json.sample (100%) rename main.py => priceybot2/main.py (82%) rename models.py => priceybot2/models.py (84%) rename {templates => priceybot2/templates}/base.html (100%) rename {templates => priceybot2/templates}/home.html (100%) rename {templates => priceybot2/templates}/index.html (100%) rename {templates => priceybot2/templates}/login.html (100%) create mode 100644 priceybot2/templates/profile.html rename {templates => priceybot2/templates}/signup.html (100%) delete mode 100644 templates/profile.html diff --git a/.gitignore b/.gitignore index ec9d63a..9df399d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,6 @@ # Configs -config/service-acct.json -config/db.py +priceybot2/config/service-acct.json +priceybot2/config/db.py # Logs *.log diff --git a/__pycache__/__init__.cpython-310.pyc b/__pycache__/__init__.cpython-310.pyc deleted file mode 100644 index 35d6fc6a31e27d2bcdc865cab0a72bf75c93922b..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 742 zcmYjP&2G~`5T5m49LKFnIUpfkAPCh0ZYZiqQzH^8^1dkie$#KMWSQ>mW9AY z8=+M{&?!)4MV45rhBJd117K#0tN|$V!m44d>)Xr`cIGS**KpBU!*`$PxVr`dA5fo# z-wM^`?qjGPeLIRHvZn|ieA=RVh-Nu)uukJ0lVoQo*O}cErg?^ z@R+_1C+Byo&mvX)Sr7zlx^umW?&%&6MlZuR6S_Y<9_|gtA$@=J>XKkzI0Gju7#9^H zE1s*F{%3KT_kF47+_;qHamFcaoTSK4($mIZ)5uNpRMEIB8<38s^$=4eDE?JNULtv{ zIE{sn9Ua}4{4}i;mvk!Typ(CKq@HizYD`RQuZT8v`5QvCsb$>ke}de?l&hz~tjKsU z<$17QB=d~tstVr9;*2LPNE5!;E7X&K(pDthDHqLuMP;ewR`=1l#4|iJUwiW4w{LmG zH$7q*avQ^keW$Tc^h0R}5pA`Y;#A}77b8t%$)0wa->SRi?%-MD4sg12!FTnrE8VgW IK5?+-9~$Ygvj6}9 diff --git a/__pycache__/auth.cpython-310.pyc b/__pycache__/auth.cpython-310.pyc deleted file mode 100644 index 9a55c0495f02b64804407ec7b2e02b6382a24385..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 673 zcma)3Jx{|h5Vf7}q#p==MV3ZlMhF$=3W+UCNMq9m;v{mMpd<72-I>oTLOJN~l#?+)izb z7^XIJb|iI~`{GgO6;qdb&uE8J-*kNF1T-|Az;q($jOf^OLOQua@pKO?C?+bHS3PS* zSxYq)tfow4lJU06CEJ5c6k|o`QrUSg*IPHKnpIgB`tGq2D6YXjd?=WzX#Wpnf z*;?}I4GTTu8xjE=CVVByy5THYvO2kGik`DtcFC=19$8_MvS6EeBhM4fK5IA1G4HvW zN^|-|L~v}qq$^i--~K90cmUIaq5)_W39a@=&5-F&Qtp7#xftm%h5#(U-t_VxECcW_ zmH{<6u;^?NN6LAq^6p9K3C+$F5)S0b&$2q_EX#!6fN}(gVP*qHpfE2TwtF;>f598t XSL{;%Xm<+X1dVV=d=g^c(mui8c@l?$ diff --git a/__pycache__/main.cpython-310.pyc b/__pycache__/main.cpython-310.pyc deleted file mode 100644 index b4cce961642c0b89fe9d0de0374d03cbac1d6880..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 542 zcmZ`#y-ve05VoD4I%!&XjV_JEj1Vf!6%t#PD2=abAWkADk!aWQATahxcn7acosk$S z2F|7u9pEJ2&!@ZlzH>bqg#_*G(-&VD-%W994i?w=+BrHw1TBfA36(5iln5rA(vfcB zQUX-C;B8srga0xR-YXTp7(A0LO}IrkB7q1k5{ThFnM8ZsNhVAOv$BUq6;-Ft6jTCK z+JS7!tb;u@EmSkH(5}pi>OkY%jGY?8;s)ObN7tdqEyeY0z6lFl_B35}vfNQ+ZrKrK z4z}(P$E#XGynrgct@B<&)wS`RsvjV?Ns+^PR(BV%A)YpC?b&_4p)#DDsR+Y{$Bn9& zMG5~ZQ%0Fl6dgOQCKVw1tLG;hBBlq&Hmh}Hy2j|{lTdrhGHV}|p|=NVqC7Lf)3nMY oq^UCUw5RI611ryt{>j2GWi9#=uFNO5hT)tY5Z>$eBb?5r2T)H6B`vgeZuGArNh@SuU9&Uc8TFH;1Iw*8h-{{-teg z%umqD**oxK;LXl^yN{V=%H7>Iqv(J7VCa0e28KJYqe99#TRUb6~MRXXX+-;2>T_>^FSf0%yZXb4d%( zS<{AT~wHUIE)R#jtQhJ zk{qQpZ7K5-s?641DHm0eH8)C-)%cfXR^^3h-4silqB0@{=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/__init__.py b/priceybot2/__init__.py similarity index 92% rename from __init__.py rename to priceybot2/__init__.py index 3c60dd7..48956f3 100644 --- a/__init__.py +++ b/priceybot2/__init__.py @@ -1,17 +1,21 @@ from flask import Flask from flask_sqlalchemy import SQLAlchemy from flask_login import LoginManager +from flask_migrate import Migrate from .config import db as db_config db = SQLAlchemy() +migrate = Migrate() def create_app(): app = Flask(__name__) - app.config['SECRET_KEY'] = '//' app.config["SQLALCHEMY_DATABASE_URI"] = db_config.SQL_URI + db.init_app(app) + migrate.init_app(app, db) + login_manager = LoginManager() login_manager.login_view = 'auth.login' login_manager.init_app(app) @@ -24,7 +28,6 @@ def create_app(): from . import models with app.app_context(): - print("Applying the DB models") db.create_all() # blueprint for auth routes in our app diff --git a/auth.py b/priceybot2/auth.py similarity index 100% rename from auth.py rename to priceybot2/auth.py diff --git a/chatbot.py b/priceybot2/chatbot.py similarity index 98% rename from chatbot.py rename to priceybot2/chatbot.py index 7369ed0..4a115a1 100644 --- a/chatbot.py +++ b/priceybot2/chatbot.py @@ -33,7 +33,7 @@ chatbot = Blueprint('chatbot', __name__) scopes = ['https://www.googleapis.com/auth/chat.bot'] -credentials = service_account.Credentials.from_service_account_file('./config/service-acct.json') +credentials = service_account.Credentials.from_service_account_file('./priceybot2/config/service-acct.json') # credentials, project_id = google.auth.default() credentials = credentials.with_scopes(scopes=scopes) chat = build('chat', 'v1', credentials=credentials) diff --git a/config/__init__.py b/priceybot2/config/__init__.py similarity index 100% rename from config/__init__.py rename to priceybot2/config/__init__.py diff --git a/config/db.py.sample b/priceybot2/config/db.py.sample similarity index 100% rename from config/db.py.sample rename to priceybot2/config/db.py.sample diff --git a/config/service-acct.json.sample b/priceybot2/config/service-acct.json.sample similarity index 100% rename from config/service-acct.json.sample rename to priceybot2/config/service-acct.json.sample diff --git a/main.py b/priceybot2/main.py similarity index 82% rename from main.py rename to priceybot2/main.py index e9d9d4e..fa47b75 100644 --- a/main.py +++ b/priceybot2/main.py @@ -12,4 +12,4 @@ def index(): @main.route('/profile') @login_required def profile(): - return render_template('profile.html', name=current_user.name, google_id=current_user.google_id) + return render_template('profile.html', name=current_user.name, google_id=current_user.google_id, is_admin=current_user.administrator) diff --git a/models.py b/priceybot2/models.py similarity index 84% rename from models.py rename to priceybot2/models.py index 15bbef0..8c20860 100644 --- a/models.py +++ b/priceybot2/models.py @@ -7,3 +7,5 @@ class User(UserMixin, db.Model): password = db.Column(db.String(100)) name = db.Column(db.String(1000)) google_id = db.Column(db.String(30), unique=True) + administrator = db.Column(db.Boolean, default=False) + diff --git a/templates/base.html b/priceybot2/templates/base.html similarity index 100% rename from templates/base.html rename to priceybot2/templates/base.html diff --git a/templates/home.html b/priceybot2/templates/home.html similarity index 100% rename from templates/home.html rename to priceybot2/templates/home.html diff --git a/templates/index.html b/priceybot2/templates/index.html similarity index 100% rename from templates/index.html rename to priceybot2/templates/index.html diff --git a/templates/login.html b/priceybot2/templates/login.html similarity index 100% rename from templates/login.html rename to priceybot2/templates/login.html diff --git a/priceybot2/templates/profile.html b/priceybot2/templates/profile.html new file mode 100644 index 0000000..b5ff5f4 --- /dev/null +++ b/priceybot2/templates/profile.html @@ -0,0 +1,9 @@ +{% extends "base.html" %} + +{% block content %} +

+ Welcome, {{ name }}!

+ Your google ID is {{ google_id }}

+ Admin?: {{ "yes" if is_admin else "no" }}

+

+{% endblock %} diff --git a/templates/signup.html b/priceybot2/templates/signup.html similarity index 100% rename from templates/signup.html rename to priceybot2/templates/signup.html diff --git a/requirements.txt b/requirements.txt index 8e8f6ab..19d9ce6 100644 --- a/requirements.txt +++ b/requirements.txt @@ -5,3 +5,4 @@ google mysqlclient flask-login flask_sqlalchemy +Flask-Migrate diff --git a/templates/profile.html b/templates/profile.html deleted file mode 100644 index 12a799a..0000000 --- a/templates/profile.html +++ /dev/null @@ -1,8 +0,0 @@ -{% extends "base.html" %} - -{% block content %} -

- Welcome, {{ name }}!

- Your google ID is {{ google_id }} -

-{% endblock %}