From 5c6e93fa4ae11512794a8078cfae02c36c3cc3a9 Mon Sep 17 00:00:00 2001 From: Llloooggg Date: Thu, 17 Nov 2022 23:08:47 +0300 Subject: [PATCH] =?UTF-8?q?Backend=20+=20Telegram:=20=D0=B8=D0=B7=D0=BC?= =?UTF-8?q?=D0=B5=D0=BD=D0=B5=D0=BD=D0=B0=20=D1=81=D1=82=D1=80=D1=83=D0=BA?= =?UTF-8?q?=D1=82=D1=83=D1=80=D0=B0=20=D0=BF=D1=80=D0=BE=D0=B5=D0=BA=D1=82?= =?UTF-8?q?=D0=B0,=20=D0=B4=D0=BE=D0=B1=D0=B0=D0=B2=D0=BB=D0=B5=D0=BD=20?= =?UTF-8?q?=D1=8D=D0=BD=D0=B4=D0=BF=D0=BE=D0=B8=D0=BD=D1=82=20=D0=B4=D0=BB?= =?UTF-8?q?=D1=8F=20=D1=80=D0=B5=D0=B3=D0=B8=D1=81=D1=82=D1=80=D0=B0=D1=86?= =?UTF-8?q?=D0=B8=D0=B8=20=D0=BD=D0=B0=20=D0=B1=D1=8D=D0=BA=D0=B5=D0=BD?= =?UTF-8?q?=D0=B4=D0=B5?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 14 ++- backend/main.py | 8 -- backend/migrations/README | 1 + backend/migrations/alembic.ini | 50 ++++++++++ backend/migrations/env.py | 97 +++++++++++++++++++ backend/migrations/script.py.mako | 24 +++++ backend/migrations/versions/226bb7e77b6b_.py | 38 ++++++++ backend/requirements.txt | 3 + backend/scripts/runserver.sh | 2 +- backend/scripts/updatedb.sh | 7 ++ backend/{ => textsouls}/__init__.py | 7 +- backend/{ => textsouls}/config.json_template | 0 backend/textsouls/main.py | 34 +++++++ backend/textsouls/models.py | 33 +++++++ telegram/{ => textsouls}/config.json_template | 0 telegram/{ => textsouls}/main.py | 0 16 files changed, 302 insertions(+), 16 deletions(-) delete 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/226bb7e77b6b_.py create mode 100755 backend/scripts/updatedb.sh rename backend/{ => textsouls}/__init__.py (79%) rename backend/{ => textsouls}/config.json_template (100%) create mode 100644 backend/textsouls/main.py create mode 100644 backend/textsouls/models.py rename telegram/{ => textsouls}/config.json_template (100%) rename telegram/{ => textsouls}/main.py (100%) diff --git a/README.md b/README.md index 8fddffb..15eb5ef 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,19 @@ # TextSouls -### Запуск бэкенда -Из корня: +### Бэкенд +Все действия производить из папки backend! + +###### Создание/подготовка БД ``` -backend/scripts/runserver.sh +scripts/updatedb.sh +``` +###### Запуск +``` +scripts/runserver.sh ``` ### Запуск Telegram -Из корня: +Из папки Telegram: ``` python telegram/main.py ``` \ No newline at end of file diff --git a/backend/main.py b/backend/main.py deleted file mode 100644 index 76f0f07..0000000 --- a/backend/main.py +++ /dev/null @@ -1,8 +0,0 @@ -from flask import Blueprint - -main = Blueprint("main", __name__) - - -@main.route("/") -def index(): - return "Nice!", 200 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..55e9df9 --- /dev/null +++ b/backend/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/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/226bb7e77b6b_.py b/backend/migrations/versions/226bb7e77b6b_.py new file mode 100644 index 0000000..4a957ae --- /dev/null +++ b/backend/migrations/versions/226bb7e77b6b_.py @@ -0,0 +1,38 @@ +"""empty message + +Revision ID: 226bb7e77b6b +Revises: +Create Date: 2022-11-17 22:55:34.747233 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '226bb7e77b6b' +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('tg_id', sa.Integer(), nullable=False), + sa.Column('first_name', sa.String(length=255), nullable=True), + sa.Column('last_name', sa.String(length=255), nullable=True), + sa.Column('username', sa.String(length=255), nullable=False), + sa.Column('registered_on', sa.DateTime(), nullable=False), + sa.Column('is_admin', sa.Boolean(), nullable=False), + sa.PrimaryKeyConstraint('id'), + sa.UniqueConstraint('tg_id') + ) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('users') + # ### end Alembic commands ### diff --git a/backend/requirements.txt b/backend/requirements.txt index abf415f..c716595 100644 --- a/backend/requirements.txt +++ b/backend/requirements.txt @@ -1,5 +1,7 @@ alembic==1.8.1 +cffi==1.15.1 click==8.1.3 +cryptography==38.0.3 Flask==2.2.2 Flask-Migrate==4.0.0 Flask-SQLAlchemy==3.0.2 @@ -10,6 +12,7 @@ itsdangerous==2.1.2 Jinja2==3.1.2 Mako==1.2.4 MarkupSafe==2.1.1 +pycparser==2.21 PyMySQL==1.0.2 SQLAlchemy==1.4.44 Werkzeug==2.2.2 diff --git a/backend/scripts/runserver.sh b/backend/scripts/runserver.sh index 0521e25..5fc5a49 100755 --- a/backend/scripts/runserver.sh +++ b/backend/scripts/runserver.sh @@ -2,7 +2,7 @@ set echo off -export FLASK_APP=backend +export FLASK_APP=textsouls export FLASK_DEBUG=true flask run \ No newline at end of file diff --git a/backend/scripts/updatedb.sh b/backend/scripts/updatedb.sh new file mode 100755 index 0000000..07de480 --- /dev/null +++ b/backend/scripts/updatedb.sh @@ -0,0 +1,7 @@ +set echo off + +export FLASK_APP=textsouls + +flask db init +flask db migrate +flask db upgrade \ No newline at end of file diff --git a/backend/__init__.py b/backend/textsouls/__init__.py similarity index 79% rename from backend/__init__.py rename to backend/textsouls/__init__.py index 9c076e3..2391c39 100644 --- a/backend/__init__.py +++ b/backend/textsouls/__init__.py @@ -1,16 +1,17 @@ import json from flask import Flask -from flask_sqlalchemy import SQLAlchemy from flask_migrate import Migrate +from textsouls.models import db + app = Flask( "__name__", ) -db = SQLAlchemy() + migrate = Migrate(app, db) -with open("backend/config.json") as config_file: +with open("textsouls/config.json") as config_file: config_data = json.load(config_file) main_settings = config_data["main_settings"] diff --git a/backend/config.json_template b/backend/textsouls/config.json_template similarity index 100% rename from backend/config.json_template rename to backend/textsouls/config.json_template diff --git a/backend/textsouls/main.py b/backend/textsouls/main.py new file mode 100644 index 0000000..cbfbfb5 --- /dev/null +++ b/backend/textsouls/main.py @@ -0,0 +1,34 @@ +from flask import Blueprint +from flask import request + +from . import db +from textsouls.models import User + +main = Blueprint("main", __name__) + + +@main.route("/") +def index(): + return "Nice!", 200 + + +@main.route("/registration", methods=["POST"]) +def registration(): + data = request.get_json() + + tg_id = data.get("tg_id") + first_name = data.get("first_name") + last_name = data.get("last_name") + username = data.get("username") + + new_user = User( + tg_id=tg_id, + first_name=first_name, + last_name=last_name, + username=username, + ) + + db.session.add(new_user) + db.session.commit() + + return "Nice!", 200 diff --git a/backend/textsouls/models.py b/backend/textsouls/models.py new file mode 100644 index 0000000..4c9a441 --- /dev/null +++ b/backend/textsouls/models.py @@ -0,0 +1,33 @@ +import datetime + +from flask_sqlalchemy import SQLAlchemy + +db = SQLAlchemy() + + +class User(db.Model): + + __tablename__ = "users" + + id = db.Column(db.Integer, primary_key=True) + tg_id = db.Column(db.Integer, unique=True, nullable=False) + first_name = db.Column(db.String(255), nullable=True) + last_name = db.Column(db.String(255), nullable=True) + username = db.Column(db.String(255), nullable=False) + registered_on = db.Column(db.DateTime, nullable=False) + is_admin = db.Column(db.Boolean, nullable=False, default=False) + + def __init__( + self, + tg_id, + first_name, + last_name, + username, + is_admin=False, + ): + self.tg_id = tg_id + self.first_name = first_name + self.last_name = last_name + self.username = username + self.registered_on = datetime.datetime.now() + self.is_admin = is_admin diff --git a/telegram/config.json_template b/telegram/textsouls/config.json_template similarity index 100% rename from telegram/config.json_template rename to telegram/textsouls/config.json_template diff --git a/telegram/main.py b/telegram/textsouls/main.py similarity index 100% rename from telegram/main.py rename to telegram/textsouls/main.py