From 47430e1c2ff6917bca342ad1b19e1ebc19d0cdfe Mon Sep 17 00:00:00 2001 From: Jagraj Aulakh Date: Thu, 16 Mar 2023 19:38:00 -0400 Subject: [PATCH 1/6] #7 python .gitignore template --- backend/.gitignore | 161 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 161 insertions(+) create mode 100644 backend/.gitignore diff --git a/backend/.gitignore b/backend/.gitignore new file mode 100644 index 0000000..7a280a2 --- /dev/null +++ b/backend/.gitignore @@ -0,0 +1,161 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/#use-with-ide +.pdm.toml + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ +app.db -- 2.49.1 From dcc172f17a86fbab513666d62743c14fe077117f Mon Sep 17 00:00:00 2001 From: Jagraj Aulakh Date: Thu, 16 Mar 2023 19:38:35 -0400 Subject: [PATCH 2/6] #7 Dependencies --- backend/requirements.txt | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 backend/requirements.txt diff --git a/backend/requirements.txt b/backend/requirements.txt new file mode 100644 index 0000000..97bba58 --- /dev/null +++ b/backend/requirements.txt @@ -0,0 +1,16 @@ +alembic==1.10.2 +click==8.1.3 +Flask==2.2.3 +Flask-HTTPAuth==4.7.0 +Flask-Login==0.6.2 +Flask-Migrate==4.0.4 +Flask-SQLAlchemy==3.0.3 +greenlet==2.0.2 +itsdangerous==2.1.2 +Jinja2==3.1.2 +Mako==1.2.4 +MarkupSafe==2.1.2 +python-dotenv==1.0.0 +SQLAlchemy==2.0.6 +typing_extensions==4.5.0 +Werkzeug==2.2.3 -- 2.49.1 From 73bdc750957d093cb9b49321d9480d4297070e41 Mon Sep 17 00:00:00 2001 From: Jagraj Aulakh Date: Thu, 16 Mar 2023 19:39:58 -0400 Subject: [PATCH 3/6] #7 Basic flask app. Setup routes, DB, and made a user model. Made initial migrations --- backend/.env.example | 1 + backend/app/__init__.py | 33 ++++++ backend/app/bp.py | 5 + backend/app/errors.py | 15 +++ backend/app/models.py | 21 ++++ backend/app/routes.py | 22 ++++ backend/config.py | 14 +++ backend/main.py | 11 ++ backend/migrations/README | 1 + backend/migrations/alembic.ini | 50 +++++++++ backend/migrations/env.py | 110 +++++++++++++++++++ backend/migrations/script.py.mako | 24 ++++ backend/migrations/versions/7736bc740f9b_.py | 47 ++++++++ backend/pyrightconfig.json | 5 + 14 files changed, 359 insertions(+) create mode 100644 backend/.env.example create mode 100644 backend/app/__init__.py create mode 100644 backend/app/bp.py create mode 100644 backend/app/errors.py create mode 100644 backend/app/models.py create mode 100644 backend/app/routes.py create mode 100644 backend/config.py create mode 100644 backend/main.py create mode 100644 backend/migrations/README create mode 100644 backend/migrations/alembic.ini create mode 100644 backend/migrations/env.py create mode 100644 backend/migrations/script.py.mako create mode 100644 backend/migrations/versions/7736bc740f9b_.py create mode 100644 backend/pyrightconfig.json diff --git a/backend/.env.example b/backend/.env.example new file mode 100644 index 0000000..08ff3ab --- /dev/null +++ b/backend/.env.example @@ -0,0 +1 @@ +FLASK_APP=main.py diff --git a/backend/app/__init__.py b/backend/app/__init__.py new file mode 100644 index 0000000..072d86e --- /dev/null +++ b/backend/app/__init__.py @@ -0,0 +1,33 @@ +from flask import Flask +from flask_sqlalchemy import SQLAlchemy +from flask_migrate import Migrate +from flask_login import LoginManager +from config import Config + + +db = SQLAlchemy() +migrate = Migrate() +login = LoginManager() +login.login_view = "login" +login.login_message = "Please log in to access this page." + + +def create_app(config_class=Config): + app = Flask(__name__) + app.config.from_object(config_class) + + db.init_app(app) + migrate.init_app(app, db) + login.init_app(app) + + app.app_context().push() + + from app.bp import bp as main_bp + + app.register_blueprint(main_bp) + + app.app_context() + return app + + +from app import models diff --git a/backend/app/bp.py b/backend/app/bp.py new file mode 100644 index 0000000..466a5b5 --- /dev/null +++ b/backend/app/bp.py @@ -0,0 +1,5 @@ +from flask import Blueprint + +bp = Blueprint('index', __name__) + +from app import routes diff --git a/backend/app/errors.py b/backend/app/errors.py new file mode 100644 index 0000000..31492c2 --- /dev/null +++ b/backend/app/errors.py @@ -0,0 +1,15 @@ +from flask import jsonify +from werkzeug.http import HTTP_STATUS_CODES + + +def error_response(status_code, message=None): + payload = {"error": HTTP_STATUS_CODES.get(status_code, "Unknown error")} + if message: + payload["message"] = message + response = jsonify(payload) + response.status_code = status_code + return response + + +def bad_request(message): + return error_response(400, message) diff --git a/backend/app/models.py b/backend/app/models.py new file mode 100644 index 0000000..290cdcb --- /dev/null +++ b/backend/app/models.py @@ -0,0 +1,21 @@ +from app import db +from flask_login import UserMixin +from datetime import datetime + + +class User(UserMixin, db.Model): + id = db.Column(db.Integer, primary_key=True) + username = db.Column(db.String(64), index=True, unique=True) + email = db.Column(db.String(120), index=True, unique=True) + password_hash = db.Column(db.String(128)) + about_me = db.Column(db.String(140)) + last_seen = db.Column(db.DateTime, default=datetime.utcnow) + token = db.Column(db.String(32), index=True, unique=True) + + def to_dict(self): + return { + "id": self.id, + "username": self.username, + "email": self.email, + "about_me": self.about_me, + } diff --git a/backend/app/routes.py b/backend/app/routes.py new file mode 100644 index 0000000..5940339 --- /dev/null +++ b/backend/app/routes.py @@ -0,0 +1,22 @@ +from app.bp import bp +from flask import Response, jsonify, request +from app.errors import error_response + +from app import db +from app.models import User + + +@bp.route("/login", methods=["POST"]) +def login(): + data = request.get_json() + print(data) + if not data.get("user_id"): + return error_response(400, "Must supply user_id") + + user = User.query.get(data.get("user_id")) + if not user: + return error_response(400, "User not found") + + resp = jsonify(user.to_dict()) + resp.status_code = 200 + return resp diff --git a/backend/config.py b/backend/config.py new file mode 100644 index 0000000..4e8da44 --- /dev/null +++ b/backend/config.py @@ -0,0 +1,14 @@ +import os +from dotenv import load_dotenv + +basedir = os.path.abspath(os.path.dirname(__file__)) +load_dotenv(os.path.join(basedir, ".env")) + + +class Config(object): + SECRET_KEY = os.environ.get("SECRET_KEY") or "you-will-never-guess" + SQLALCHEMY_DATABASE_URI = os.environ.get("DATABASE_URL", "").replace( + "postgres://", "postgresql://" + ) or "sqlite:///" + os.path.join(basedir, "app.db") + SQLALCHEMY_TRACK_MODIFICATIONS = True + ADMINS = ["your-email@example.com"] diff --git a/backend/main.py b/backend/main.py new file mode 100644 index 0000000..15d9e6f --- /dev/null +++ b/backend/main.py @@ -0,0 +1,11 @@ +import dotenv +dotenv.load_dotenv() + +from app import create_app, db + +app = create_app() + +@app.shell_context_processor +def make_shell_context(): + return {} + diff --git a/backend/migrations/README b/backend/migrations/README new file mode 100644 index 0000000..0e04844 --- /dev/null +++ b/backend/migrations/README @@ -0,0 +1 @@ +Single-database configuration for Flask. diff --git a/backend/migrations/alembic.ini b/backend/migrations/alembic.ini new file mode 100644 index 0000000..ec9d45c --- /dev/null +++ b/backend/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/backend/migrations/env.py b/backend/migrations/env.py new file mode 100644 index 0000000..89f80b2 --- /dev/null +++ b/backend/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/backend/migrations/script.py.mako b/backend/migrations/script.py.mako new file mode 100644 index 0000000..2c01563 --- /dev/null +++ b/backend/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/backend/migrations/versions/7736bc740f9b_.py b/backend/migrations/versions/7736bc740f9b_.py new file mode 100644 index 0000000..9a00ee3 --- /dev/null +++ b/backend/migrations/versions/7736bc740f9b_.py @@ -0,0 +1,47 @@ +"""empty message + +Revision ID: 7736bc740f9b +Revises: +Create Date: 2023-03-16 19:20:29.115598 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '7736bc740f9b' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('user', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('username', sa.String(length=64), nullable=True), + sa.Column('email', sa.String(length=120), nullable=True), + sa.Column('password_hash', sa.String(length=128), nullable=True), + sa.Column('about_me', sa.String(length=140), nullable=True), + sa.Column('last_seen', sa.DateTime(), nullable=True), + sa.Column('token', sa.String(length=32), nullable=True), + sa.PrimaryKeyConstraint('id') + ) + with op.batch_alter_table('user', schema=None) as batch_op: + batch_op.create_index(batch_op.f('ix_user_email'), ['email'], unique=True) + batch_op.create_index(batch_op.f('ix_user_token'), ['token'], unique=True) + batch_op.create_index(batch_op.f('ix_user_username'), ['username'], unique=True) + + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + with op.batch_alter_table('user', schema=None) as batch_op: + batch_op.drop_index(batch_op.f('ix_user_username')) + batch_op.drop_index(batch_op.f('ix_user_token')) + batch_op.drop_index(batch_op.f('ix_user_email')) + + op.drop_table('user') + # ### end Alembic commands ### diff --git a/backend/pyrightconfig.json b/backend/pyrightconfig.json new file mode 100644 index 0000000..ce9c89c --- /dev/null +++ b/backend/pyrightconfig.json @@ -0,0 +1,5 @@ +{ + "venvPath": ".", + "venv": "venv", + "useLibraryCodeForTypes": true +} -- 2.49.1 From 5d4e02569613ecd23fca18922f9bf508c6cf4e7a Mon Sep 17 00:00:00 2001 From: Jagraj Aulakh Date: Fri, 17 Mar 2023 00:58:55 -0400 Subject: [PATCH 4/6] #7 Made boot script --- backend/boot.sh | 12 ++++++++++++ backend/requirements.txt | 1 + 2 files changed, 13 insertions(+) create mode 100755 backend/boot.sh diff --git a/backend/boot.sh b/backend/boot.sh new file mode 100755 index 0000000..cabacd4 --- /dev/null +++ b/backend/boot.sh @@ -0,0 +1,12 @@ +#!/bin/bash + +source ./venv/bin/activate + +pip install -r ./requirements.txt + +flask db update + + +exec gunicorn -b :5000 --access-logfile - --error-logfile - main:app + + diff --git a/backend/requirements.txt b/backend/requirements.txt index 97bba58..06f76c6 100644 --- a/backend/requirements.txt +++ b/backend/requirements.txt @@ -6,6 +6,7 @@ Flask-Login==0.6.2 Flask-Migrate==4.0.4 Flask-SQLAlchemy==3.0.3 greenlet==2.0.2 +gunicorn==20.1.0 itsdangerous==2.1.2 Jinja2==3.1.2 Mako==1.2.4 -- 2.49.1 From 3242c229b8e322f3cd7b5f0e4e6e347ea47bf4c5 Mon Sep 17 00:00:00 2001 From: Jagraj Aulakh Date: Fri, 17 Mar 2023 00:59:14 -0400 Subject: [PATCH 5/6] #7 Made Dockerfile for backend --- backend/Dockerfile | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 backend/Dockerfile diff --git a/backend/Dockerfile b/backend/Dockerfile new file mode 100644 index 0000000..5d20aa7 --- /dev/null +++ b/backend/Dockerfile @@ -0,0 +1,10 @@ +FROM python:3.10.9 + +WORKDIR /tmp +RUN python -m venv venv +COPY ./requirements.txt /code/requirements.txt +RUN python -m pip install -r /code/requirements.txt + +WORKDIR /code +COPY ./ /code +CMD sh boot.sh -- 2.49.1 From 9b0b7b0ec7c0d5ceac281521fa1780a4513f6672 Mon Sep 17 00:00:00 2001 From: Jagraj Aulakh Date: Fri, 17 Mar 2023 01:49:15 -0400 Subject: [PATCH 6/6] #7 Fixed boot script to properly upgrade DB. --- backend/boot.sh | 5 ++--- backend/main.py | 3 ++- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/backend/boot.sh b/backend/boot.sh index cabacd4..0743b5d 100755 --- a/backend/boot.sh +++ b/backend/boot.sh @@ -1,11 +1,10 @@ #!/bin/bash -source ./venv/bin/activate +. ./venv/bin/activate pip install -r ./requirements.txt -flask db update - +flask db upgrade exec gunicorn -b :5000 --access-logfile - --error-logfile - main:app diff --git a/backend/main.py b/backend/main.py index 15d9e6f..1cbaba5 100644 --- a/backend/main.py +++ b/backend/main.py @@ -2,10 +2,11 @@ import dotenv dotenv.load_dotenv() from app import create_app, db +from app.models import User app = create_app() @app.shell_context_processor def make_shell_context(): - return {} + return {'db': db, 'User': User} -- 2.49.1