diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 0000000..fe59857 --- /dev/null +++ b/alembic.ini @@ -0,0 +1,147 @@ +# A generic, single database configuration. + +[alembic] +# path to migration scripts. +# this is typically a path given in POSIX (e.g. forward slashes) +# format, relative to the token %(here)s which refers to the location of this +# ini file +script_location = %(here)s/alembic + +# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s +# Uncomment the line below if you want the files to be prepended with date and time +# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file +# for all available tokens +# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s + +# sys.path path, will be prepended to sys.path if present. +# defaults to the current working directory. for multiple paths, the path separator +# is defined by "path_separator" below. +prepend_sys_path = . + + +# timezone to use when rendering the date within the migration file +# as well as the filename. +# If specified, requires the tzdata library which can be installed by adding +# `alembic[tz]` to the pip requirements. +# string value is passed to ZoneInfo() +# leave blank for localtime +# timezone = + +# max length of characters to apply to the "slug" field +# truncate_slug_length = 40 + +# set to 'true' to run the environment during +# the 'revision' command, regardless of autogenerate +# revision_environment = false + +# set to 'true' to allow .pyc and .pyo files without +# a source .py file to be detected as revisions in the +# versions/ directory +# sourceless = false + +# version location specification; This defaults +# to /versions. When using multiple version +# directories, initial revisions must be specified with --version-path. +# The path separator used here should be the separator specified by "path_separator" +# below. +# version_locations = %(here)s/bar:%(here)s/bat:%(here)s/alembic/versions + +# path_separator; This indicates what character is used to split lists of file +# paths, including version_locations and prepend_sys_path within configparser +# files such as alembic.ini. +# The default rendered in new alembic.ini files is "os", which uses os.pathsep +# to provide os-dependent path splitting. +# +# Note that in order to support legacy alembic.ini files, this default does NOT +# take place if path_separator is not present in alembic.ini. If this +# option is omitted entirely, fallback logic is as follows: +# +# 1. Parsing of the version_locations option falls back to using the legacy +# "version_path_separator" key, which if absent then falls back to the legacy +# behavior of splitting on spaces and/or commas. +# 2. Parsing of the prepend_sys_path option falls back to the legacy +# behavior of splitting on spaces, commas, or colons. +# +# Valid values for path_separator are: +# +# path_separator = : +# path_separator = ; +# path_separator = space +# path_separator = newline +# +# Use os.pathsep. Default configuration used for new projects. +path_separator = os + +# set to 'true' to search source files recursively +# in each "version_locations" directory +# new in Alembic version 1.10 +# recursive_version_locations = false + +# the output encoding used when revision files +# are written from script.py.mako +# output_encoding = utf-8 + +# database URL. This is consumed by the user-maintained env.py script only. +# other means of configuring database URLs may be customized within the env.py +# file. +sqlalchemy.url = sqlite:///aps_db.db + + +[post_write_hooks] +# post_write_hooks defines scripts or Python functions that are run +# on newly generated revision scripts. See the documentation for further +# detail and examples + +# format using "black" - use the console_scripts runner, against the "black" entrypoint +# hooks = black +# black.type = console_scripts +# black.entrypoint = black +# black.options = -l 79 REVISION_SCRIPT_FILENAME + +# lint with attempts to fix using "ruff" - use the module runner, against the "ruff" module +# hooks = ruff +# ruff.type = module +# ruff.module = ruff +# ruff.options = check --fix REVISION_SCRIPT_FILENAME + +# Alternatively, use the exec runner to execute a binary found on your PATH +# hooks = ruff +# ruff.type = exec +# ruff.executable = ruff +# ruff.options = check --fix REVISION_SCRIPT_FILENAME + +# Logging configuration. This is also consumed by the user-maintained +# env.py script only. +[loggers] +keys = root,sqlalchemy,alembic + +[handlers] +keys = console + +[formatters] +keys = generic + +[logger_root] +level = WARNING +handlers = console +qualname = + +[logger_sqlalchemy] +level = WARNING +handlers = +qualname = sqlalchemy.engine + +[logger_alembic] +level = INFO +handlers = +qualname = alembic + +[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/alembic/README b/alembic/README new file mode 100644 index 0000000..98e4f9c --- /dev/null +++ b/alembic/README @@ -0,0 +1 @@ +Generic single-database configuration. \ No newline at end of file diff --git a/alembic/env.py b/alembic/env.py new file mode 100644 index 0000000..de21a6d --- /dev/null +++ b/alembic/env.py @@ -0,0 +1,80 @@ +from logging.config import fileConfig + +from sqlalchemy import engine_from_config +from sqlalchemy import pool + +from alembic import context + +from allmende_payment_system.models import Base + +# 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. +if config.config_file_name is not None: + fileConfig(config.config_file_name) + +# add your model's MetaData object here +# for 'autogenerate' support +# from myapp import mymodel +# target_metadata = mymodel.Base.metadata +target_metadata = Base.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() -> None: + """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, + dialect_opts={"paramstyle": "named"}, + ) + + with context.begin_transaction(): + context.run_migrations() + + +def run_migrations_online() -> None: + """Run migrations in 'online' mode. + + In this scenario we need to create an Engine + and associate a connection with the context. + + """ + connectable = engine_from_config( + config.get_section(config.config_ini_section, {}), + prefix="sqlalchemy.", + poolclass=pool.NullPool, + ) + + with connectable.connect() as connection: + context.configure( + connection=connection, target_metadata=target_metadata + ) + + with context.begin_transaction(): + context.run_migrations() + + +if context.is_offline_mode(): + run_migrations_offline() +else: + run_migrations_online() diff --git a/alembic/script.py.mako b/alembic/script.py.mako new file mode 100644 index 0000000..1101630 --- /dev/null +++ b/alembic/script.py.mako @@ -0,0 +1,28 @@ +"""${message} + +Revision ID: ${up_revision} +Revises: ${down_revision | comma,n} +Create Date: ${create_date} + +""" +from typing import Sequence, Union + +from alembic import op +import sqlalchemy as sa +${imports if imports else ""} + +# revision identifiers, used by Alembic. +revision: str = ${repr(up_revision)} +down_revision: Union[str, Sequence[str], None] = ${repr(down_revision)} +branch_labels: Union[str, Sequence[str], None] = ${repr(branch_labels)} +depends_on: Union[str, Sequence[str], None] = ${repr(depends_on)} + + +def upgrade() -> None: + """Upgrade schema.""" + ${upgrades if upgrades else "pass"} + + +def downgrade() -> None: + """Downgrade schema.""" + ${downgrades if downgrades else "pass"} diff --git a/alembic/versions/958d7aee2b21_initial_model.py b/alembic/versions/958d7aee2b21_initial_model.py new file mode 100644 index 0000000..e692849 --- /dev/null +++ b/alembic/versions/958d7aee2b21_initial_model.py @@ -0,0 +1,132 @@ +"""Initial model + +Revision ID: 958d7aee2b21 +Revises: +Create Date: 2026-01-23 10:10:36.825333 + +""" +from typing import Sequence, Union + +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision: str = '958d7aee2b21' +down_revision: Union[str, Sequence[str], None] = None +branch_labels: Union[str, Sequence[str], None] = None +depends_on: Union[str, Sequence[str], None] = None + + +def upgrade() -> None: + """Upgrade schema.""" + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('aps_account', + sa.Column('id', sa.Integer(), autoincrement=True, nullable=False), + sa.Column('name', sa.String(), nullable=False), + sa.PrimaryKeyConstraint('id'), + sa.UniqueConstraint('name') + ) + op.create_table('aps_area', + sa.Column('id', sa.Integer(), autoincrement=True, nullable=False), + sa.Column('name', sa.String(), nullable=False), + sa.Column('description', sa.String(), nullable=True), + sa.Column('image_path', sa.String(), nullable=True), + sa.PrimaryKeyConstraint('id'), + sa.UniqueConstraint('name') + ) + op.create_table('aps_user', + sa.Column('id', sa.Integer(), autoincrement=True, nullable=False), + sa.Column('username', sa.String(), nullable=False), + sa.Column('display_name', sa.String(), nullable=False), + sa.PrimaryKeyConstraint('id'), + sa.UniqueConstraint('username') + ) + op.create_table('aps_user_group', + sa.Column('id', sa.Integer(), autoincrement=True, nullable=False), + sa.Column('name', sa.String(), nullable=False), + sa.Column('description', sa.String(), nullable=True), + sa.PrimaryKeyConstraint('id'), + sa.UniqueConstraint('name') + ) + op.create_table('aps_order', + sa.Column('id', sa.Integer(), autoincrement=True, nullable=False), + sa.Column('user_id', sa.Integer(), nullable=False), + sa.ForeignKeyConstraint(['user_id'], ['aps_user.id'], ), + sa.PrimaryKeyConstraint('id') + ) + op.create_table('aps_permission', + sa.Column('id', sa.Integer(), autoincrement=True, nullable=False), + sa.Column('scope', sa.String(), nullable=False), + sa.Column('action', sa.String(), nullable=False), + sa.Column('user_group_id', sa.Integer(), nullable=False), + sa.ForeignKeyConstraint(['user_group_id'], ['aps_user_group.id'], ), + sa.PrimaryKeyConstraint('id') + ) + op.create_table('aps_product', + sa.Column('id', sa.Integer(), autoincrement=True, nullable=False), + sa.Column('name', sa.String(), nullable=False), + sa.Column('price', sa.Numeric(precision=10, scale=2), nullable=False), + sa.Column('unit_of_measure', sa.Enum('g', 'kg', 'l', 'piece', native_enum=False), nullable=False), + sa.Column('allow_fractional', sa.Boolean(), nullable=False), + sa.Column('vat_rate', sa.Numeric(precision=10, scale=2), nullable=False), + sa.Column('area_id', sa.Integer(), nullable=False), + sa.Column('image_path', sa.String(), nullable=True), + sa.ForeignKeyConstraint(['area_id'], ['aps_area.id'], ), + sa.PrimaryKeyConstraint('id'), + sa.UniqueConstraint('name') + ) + op.create_table('aps_user_account_association', + sa.Column('user_id', sa.Integer(), nullable=False), + sa.Column('account_id', sa.Integer(), nullable=False), + sa.ForeignKeyConstraint(['account_id'], ['aps_account.id'], ), + sa.ForeignKeyConstraint(['user_id'], ['aps_user.id'], ), + sa.PrimaryKeyConstraint('user_id', 'account_id') + ) + op.create_table('aps_user_user_group_association', + sa.Column('user_id', sa.Integer(), nullable=False), + sa.Column('user_group_id', sa.Integer(), nullable=False), + sa.ForeignKeyConstraint(['user_group_id'], ['aps_user_group.id'], ), + sa.ForeignKeyConstraint(['user_id'], ['aps_user.id'], ), + sa.PrimaryKeyConstraint('user_id', 'user_group_id') + ) + op.create_table('aps_order_item', + sa.Column('id', sa.Integer(), autoincrement=True, nullable=False), + sa.Column('order_id', sa.Integer(), nullable=False), + sa.Column('product_id', sa.Integer(), nullable=False), + sa.Column('quantity', sa.Numeric(), nullable=False), + sa.Column('total_amount', sa.Numeric(precision=10, scale=2), nullable=False), + sa.ForeignKeyConstraint(['order_id'], ['aps_order.id'], ), + sa.ForeignKeyConstraint(['product_id'], ['aps_product.id'], ), + sa.PrimaryKeyConstraint('id') + ) + op.create_table('aps_transaction', + sa.Column('id', sa.Integer(), autoincrement=True, nullable=False), + sa.Column('type', sa.Enum('order', 'deposit', 'withdrawal', 'expense', native_enum=False), nullable=False), + sa.Column('quantity', sa.Numeric(precision=10, scale=2), nullable=True), + sa.Column('timestamp', sa.DateTime(), nullable=False), + sa.Column('total_amount', sa.Numeric(precision=10, scale=2), nullable=False), + sa.Column('order_id', sa.Integer(), nullable=True), + sa.Column('account_id', sa.Integer(), nullable=False), + sa.ForeignKeyConstraint(['account_id'], ['aps_account.id'], ), + sa.ForeignKeyConstraint(['order_id'], ['aps_order.id'], ), + sa.PrimaryKeyConstraint('id') + ) + # ### end Alembic commands ### + + +def downgrade() -> None: + """Downgrade schema.""" + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('aps_transaction') + op.drop_table('aps_order_item') + op.drop_table('aps_user_user_group_association') + op.drop_table('aps_user_account_association') + op.drop_table('aps_product') + op.drop_table('aps_permission') + op.drop_table('aps_order') + op.drop_table('aps_user_group') + op.drop_table('aps_user') + op.drop_table('aps_area') + op.drop_table('aps_account') + # ### end Alembic commands ### diff --git a/justfile b/justfile index 0e6e74d..2e4665b 100644 --- a/justfile +++ b/justfile @@ -4,5 +4,5 @@ lint: reset_db: rm -f aps_db.db - uv run python -c "from allmende_payment_system.database import create_tables; create_tables()" + uv run alembic upgrade heads for file in db_fixtures/*.sql; do sqlite3 aps_db.db < "$file"; done \ No newline at end of file diff --git a/src/allmende_payment_system/api/__init__.py b/src/allmende_payment_system/api/__init__.py index 9ae8d3c..25885f2 100644 --- a/src/allmende_payment_system/api/__init__.py +++ b/src/allmende_payment_system/api/__init__.py @@ -1,7 +1,6 @@ from fastapi import APIRouter, Request from allmende_payment_system.api.dependencies import SessionDep, UserDep -from allmende_payment_system.database import ensure_user from allmende_payment_system.tools import get_jinja_renderer root_router = APIRouter() diff --git a/src/allmende_payment_system/api/admin.py b/src/allmende_payment_system/api/admin.py index f920da9..b26d081 100644 --- a/src/allmende_payment_system/api/admin.py +++ b/src/allmende_payment_system/api/admin.py @@ -6,7 +6,7 @@ from sqlalchemy import select from starlette import status from starlette.responses import RedirectResponse -from allmende_payment_system.api import types +from allmende_payment_system import types from allmende_payment_system.api.dependencies import SessionDep, UserDep from allmende_payment_system.models import Area, Permission, Product, User, UserGroup from allmende_payment_system.tools import get_jinja_renderer diff --git a/src/allmende_payment_system/models.py b/src/allmende_payment_system/models.py index 6760d59..9425319 100644 --- a/src/allmende_payment_system/models.py +++ b/src/allmende_payment_system/models.py @@ -12,7 +12,7 @@ from sqlalchemy.orm import ( relationship, ) -from allmende_payment_system.api.types import UnitsOfMeasure +from allmende_payment_system.types import UnitsOfMeasure TABLE_PREFIX = "aps_" diff --git a/src/allmende_payment_system/api/types.py b/src/allmende_payment_system/types.py similarity index 100% rename from src/allmende_payment_system/api/types.py rename to src/allmende_payment_system/types.py