diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 0000000..09a6086 --- /dev/null +++ b/alembic.ini @@ -0,0 +1,105 @@ +# A generic, single database configuration. + +[alembic] +# path to migration scripts +script_location = 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. +prepend_sys_path = . + +# timezone to use when rendering the date within the migration file +# as well as the filename. +# If specified, requires the python-dateutil library that can be +# installed by adding `alembic[tz]` to the pip requirements +# string value is passed to dateutil.tz.gettz() +# leave blank for localtime +timezone = UTC + +# 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 alembic/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 "version_path_separator" below. +# version_locations = %(here)s/bar:%(here)s/bat:alembic/versions + +# version path separator; As mentioned above, this is the character used to split +# version_locations. The default within new alembic.ini files is "os", which uses os.pathsep. +# If this key is omitted entirely, it falls back to the legacy behavior of splitting on spaces and/or commas. +# Valid values for version_path_separator are: +# +# version_path_separator = : +# version_path_separator = ; +# version_path_separator = space +version_path_separator = os # Use os.pathsep. Default configuration used for new projects. + +# the output encoding used when revision files +# are written from script.py.mako +# output_encoding = utf-8 + +sqlalchemy.url = postgresql://pf-budget:muster-neutron-omega@database.lan/pf-budget + + +[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 + +# Logging configuration +[loggers] +keys = root,sqlalchemy,alembic + +[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 + +[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..4b46b18 --- /dev/null +++ b/alembic/env.py @@ -0,0 +1,88 @@ +from logging.config import fileConfig + +from sqlalchemy import engine_from_config +from sqlalchemy import pool + +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. +if config.config_file_name is not None: + fileConfig(config.config_file_name) + +# add your model's MetaData object here +# for 'autogenerate' support +from pfbudget.db.model import Base +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 include_name(name, type_, parent_names): + if type_ == "schema": + return name in ["transactions"] + else: + return True + + +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, + include_name=include_name, + include_schemas=True, + compare_type=True, + ) + + 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..55df286 --- /dev/null +++ b/alembic/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() -> None: + ${upgrades if upgrades else "pass"} + + +def downgrade() -> None: + ${downgrades if downgrades else "pass"} diff --git a/alembic/versions/50ff1fbb8a00_init.py b/alembic/versions/50ff1fbb8a00_init.py new file mode 100644 index 0000000..4817884 --- /dev/null +++ b/alembic/versions/50ff1fbb8a00_init.py @@ -0,0 +1,111 @@ +"""Init + +Revision ID: 50ff1fbb8a00 +Revises: +Create Date: 2022-12-03 11:49:30.450115+00:00 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = "50ff1fbb8a00" +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade() -> None: + # ### commands auto generated by Alembic - please adjust! ### + op.create_table( + "banks", + sa.Column("name", sa.String(), nullable=False), + sa.Column("BIC", sa.String(length=8), nullable=False), + sa.Column( + "type", + sa.Enum( + "checking", + "savings", + "investment", + "VISA", + "MASTERCARD", + name="accounttype", + schema="transactions", + inherit_schema=True, + ), + nullable=False, + ), + sa.PrimaryKeyConstraint("BIC", "type", name=op.f("pk_banks")), + sa.UniqueConstraint("name", name=op.f("uq_banks_name")), + schema="transactions", + ) + op.create_table( + "nordigen", + sa.Column("name", sa.Text(), nullable=False), + sa.Column("bank_id", sa.String(), nullable=True), + sa.Column("requisition_id", sa.String(), nullable=True), + sa.Column("invert", sa.Boolean(), nullable=True), + sa.ForeignKeyConstraint( + ["name"], ["transactions.banks.name"], name=op.f("fk_nordigen_name_banks") + ), + sa.PrimaryKeyConstraint("name", name=op.f("pk_nordigen")), + schema="transactions", + ) + op.create_table( + "originals", + sa.Column("id", sa.BigInteger(), autoincrement=True, nullable=False), + sa.Column("date", sa.Date(), nullable=False), + sa.Column("description", sa.String(), nullable=True), + sa.Column("bank", sa.Text(), nullable=False), + sa.Column("amount", sa.Numeric(precision=16, scale=2), nullable=False), + sa.ForeignKeyConstraint( + ["bank"], ["transactions.banks.name"], name=op.f("fk_originals_bank_banks") + ), + sa.PrimaryKeyConstraint("id", name=op.f("pk_originals")), + schema="transactions", + ) + op.create_table( + "categorized", + sa.Column("id", sa.BigInteger(), nullable=False), + sa.Column("category", sa.String(), nullable=False), + sa.ForeignKeyConstraint( + ["id"], + ["transactions.originals.id"], + name=op.f("fk_categorized_id_originals"), + ), + sa.PrimaryKeyConstraint("id", name=op.f("pk_categorized")), + schema="transactions", + ) + op.create_table( + "notes", + sa.Column("id", sa.BigInteger(), nullable=False), + sa.Column("note", sa.String(), nullable=False), + sa.ForeignKeyConstraint( + ["id"], ["transactions.originals.id"], name=op.f("fk_notes_id_originals") + ), + sa.PrimaryKeyConstraint("id", name=op.f("pk_notes")), + schema="transactions", + ) + op.create_table( + "tags", + sa.Column("id", sa.BigInteger(), nullable=False), + sa.Column("tag", sa.String(), nullable=False), + sa.ForeignKeyConstraint( + ["id"], ["transactions.originals.id"], name=op.f("fk_tags_id_originals") + ), + sa.PrimaryKeyConstraint("id", "tag", name=op.f("pk_tags")), + schema="transactions", + ) + # ### end Alembic commands ### + + +def downgrade() -> None: + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table("tags", schema="transactions") + op.drop_table("notes", schema="transactions") + op.drop_table("categorized", schema="transactions") + op.drop_table("originals", schema="transactions") + op.drop_table("nordigen", schema="transactions") + op.drop_table("banks", schema="transactions") + # ### end Alembic commands ### diff --git a/pfbudget/db/model.py b/pfbudget/db/model.py new file mode 100644 index 0000000..492e877 --- /dev/null +++ b/pfbudget/db/model.py @@ -0,0 +1,99 @@ +from sqlalchemy import ( + BigInteger, + Enum, + ForeignKey, + MetaData, + Numeric, + String, + Text, +) +from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column, MappedAsDataclass + +from decimal import Decimal +from typing import Annotated, Optional +import datetime as dt +import enum + + +class Base(MappedAsDataclass, DeclarativeBase): + __table_args__ = {"schema": "transactions"} + metadata = MetaData( + naming_convention={ + "ix": "ix_%(column_0_label)s", + "uq": "uq_%(table_name)s_%(column_0_name)s", + "ck": "ck_%(table_name)s_`%(constraint_name)s`", + "fk": "fk_%(table_name)s_%(column_0_name)s_%(referred_table_name)s", + "pk": "pk_%(table_name)s", + } + ) + + +class AccountType(enum.Enum): + checking = enum.auto() + savings = enum.auto() + investment = enum.auto() + VISA = enum.auto() + MASTERCARD = enum.auto() + + +accounttype = Annotated[ + AccountType, + mapped_column(Enum(AccountType, inherit_schema=True)), +] + + +class Bank(Base): + __tablename__ = "banks" + + name: Mapped[str] = mapped_column(unique=True) + BIC: Mapped[str] = mapped_column(String(8), primary_key=True) + type: Mapped[accounttype] = mapped_column(primary_key=True) + + +bankfk = Annotated[str, mapped_column(Text, ForeignKey(Bank.name))] + +idpk = Annotated[int, mapped_column(BigInteger, primary_key=True)] +money = Annotated[Decimal, mapped_column(Numeric(16, 2), nullable=False)] + + +class Original(Base): + __tablename__ = "originals" + + id: Mapped[idpk] = mapped_column(autoincrement=True) + date: Mapped[dt.date] + description: Mapped[Optional[str]] + bank: Mapped[bankfk] + amount: Mapped[money] + + +idfk = Annotated[int, mapped_column(BigInteger, ForeignKey(Original.id))] + + +class Categorized(Base): + __tablename__ = "categorized" + + id: Mapped[idfk] = mapped_column(primary_key=True) + category: Mapped[str] + + +class Note(Base): + __tablename__ = "notes" + + id: Mapped[idfk] = mapped_column(primary_key=True) + note: Mapped[str] + + +class Nordigen(Base): + __tablename__ = "nordigen" + + name: Mapped[bankfk] = mapped_column(primary_key=True) + bank_id: Mapped[Optional[str]] + requisition_id: Mapped[Optional[str]] + invert: Mapped[Optional[bool]] + + +class Tags(Base): + __tablename__ = "tags" + + id: Mapped[idfk] = mapped_column(primary_key=True) + tag: Mapped[str] = mapped_column(primary_key=True)