From 818b2884b27163f57768ad893489c40d29d7e234 Mon Sep 17 00:00:00 2001 From: Cara Salter Date: Mon, 5 Dec 2022 16:28:49 -0500 Subject: [PATCH] meta: init structure --- Makefile | 33 +++++++++++++ goathacks/__init__.py | 20 ++++++++ goathacks/database.py | 14 ++++++ migrations/README | 1 + migrations/alembic.ini | 50 ++++++++++++++++++++ migrations/env.py | 97 +++++++++++++++++++++++++++++++++++++++ migrations/script.py.mako | 24 ++++++++++ requirements.txt | 6 +++ 8 files changed, 245 insertions(+) create mode 100644 Makefile create mode 100644 goathacks/__init__.py create mode 100644 goathacks/database.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 diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..bab2864 --- /dev/null +++ b/Makefile @@ -0,0 +1,33 @@ +SHELL := /bin/bash +all: clean + +# Clean up temp files +#------------------------------------------------------------------ +clean: + @echo "Cleaning up temp files" + @find . -name '*~' -ls -delete + @find . -name '*.bak' -ls -delete + @echo "Cleaning up __pycache__ directories" + @find . -name __pycache__ -type d -not -path "./.venv/*" -ls -exec rm -r {} + + @echo "Cleaning up logfiles" + @find ./logs -name '*.log*' -ls -delete + @echo "Cleaning up flask_session" + @find . -name flask_session -type d -not -path "./.venv/*" -ls -exec rm -r {} + + +init_env: + python -m .venv venv + source .venv/bin/activate && pip3 install --upgrade pip + source .venv/bin/activate && pip3 install -r requirements.txt txt + +upgrade_env: + source .venv/bin/activate && pip3 install --upgrade -r requirements.txt txt + +daemon: + @echo "--- STARTING UWSGI DAEMON ---" + @echo "" + @echo "" + source .venv/bin/activate && uwsgi --py-autoreload=5 --socket 0.0.0.0:8000 --protocol=http --wsgi-file netreg.py --enable-threads --master + @echo "" + @echo "" + @echo "--- STARTING UWSGI DAEMON ---" + diff --git a/goathacks/__init__.py b/goathacks/__init__.py new file mode 100644 index 0000000..25893b7 --- /dev/null +++ b/goathacks/__init__.py @@ -0,0 +1,20 @@ +from flask import Flask +from flask_sqlalchemy import SQLAlchemy +from flask_migrate import Migrate +from flask_login import LoginManager + + +db = SQLAlchemy() +migrate = Migrate() +login = LoginManager() + +def create_app(): + app = Flask(__name__) + + app.config.from_pyfile("config.py") + + db.init_app(app) + migrate.init_app(app, db) + login.init_app(app) + + return app diff --git a/goathacks/database.py b/goathacks/database.py new file mode 100644 index 0000000..f5fba56 --- /dev/null +++ b/goathacks/database.py @@ -0,0 +1,14 @@ + + +from flask_login import UserMixin +from sqlalchemy import Boolean, Column, DateTime, Integer, String +from . import db + +class User(db.Model, UserMixin): + id = Column(Integer, primary_key=True) + email = Column(String, unique=True, nullable=False) + password = Column(String, nullable=False) + first_name = Column(String, nullable=False) + last_login = Column(DateTime, nullable=False) + active = Column(Boolean, nullable=False) + is_admin = Column(Boolean, nullable=False, default=False) 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..55e9df9 --- /dev/null +++ b/migrations/env.py @@ -0,0 +1,97 @@ +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_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 = current_app.extensions['migrate'].db.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/requirements.txt b/requirements.txt index 2306ffc..df6c897 100644 --- a/requirements.txt +++ b/requirements.txt @@ -9,5 +9,11 @@ itsdangerous==2.1.2 Jinja2==3.1.2 Mako==1.2.4 MarkupSafe==2.1.1 +msgpack==1.0.4 +neovim==0.3.1 +psycopg2==2.9.5 +pynvim==0.4.3 +python-dotenv==0.21.0 SQLAlchemy==1.4.44 +uWSGI==2.0.21 Werkzeug==2.2.2