adds alembic migrations and load statuses script

aim/digifeeds/bin/load_statuses.py

@@ -0,0 +1,10 @@
+from aim.digifeeds.database.models import load_statuses
+from aim.digifeeds.database.main import SessionLocal
+import sys
+
+def main():
+    with SessionLocal() as db_session:
+      load_statuses(session=db_session)
+
+if __name__=='__main__':
+    sys.exit(main())

aim/digifeeds/database/alembic.ini

@@ -0,0 +1,117 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+# Use forward slashes (/) also on windows to provide an os agnostic path
+script_location = migrations
+
+# 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>=3.9 or backports.zoneinfo library.
+# Any required deps can 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 migrations/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:migrations/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.
+
+# 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
+
+#in env.py
+#sqlalchemy.url = driver://user:pass@localhost/dbname
+
+
+[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 exec runner, execute a binary
+# hooks = ruff
+# ruff.type = exec
+# ruff.executable = %(here)s/.venv/bin/ruff
+# ruff.options = --fix 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

aim/digifeeds/database/main.py

@@ -7,7 +7,7 @@
 if S.ci_on == None: # pragma: no cover 
    engine = create_engine(S.mysql_database)
    SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)
-   models.Base.metadata.create_all(bind=engine)
+#    models.Base.metadata.create_all(bind=engine)
 
 app = FastAPI()
 

aim/digifeeds/database/migrations/README

@@ -0,0 +1 @@
+Generic single-database configuration.

aim/digifeeds/database/migrations/env.py

@@ -0,0 +1,82 @@
+from logging.config import fileConfig
+
+from sqlalchemy import engine_from_config
+from sqlalchemy import pool
+
+from alembic import context
+
+from aim.services import S
+
+# this is the Alembic Config object, which provides
+# access to the values within the .ini file in use.
+config = context.config
+
+# Set url from environment variable
+config.set_main_option('sqlalchemy.url', S.mysql_database)
+
+# 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 aim.digifeeds.database.models 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 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()

aim/digifeeds/database/migrations/script.py.mako

@@ -0,0 +1,26 @@
+"""${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, 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:
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade() -> None:
+    ${downgrades if downgrades else "pass"}

aim/digifeeds/database/migrations/versions/bbb334fc10e7_creating_initial_tables.py

@@ -0,0 +1,51 @@
+"""Creating initial tables
+
+Revision ID: bbb334fc10e7
+Revises: 
+Create Date: 2024-09-19 18:37:32.652676
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision: str = 'bbb334fc10e7'
+down_revision: Union[str, None] = None
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table('items',
+    sa.Column('barcode', sa.String(length=256), nullable=False),
+    sa.Column('created_at', sa.DateTime(timezone=True), server_default=sa.text('now()'), nullable=False),
+    sa.PrimaryKeyConstraint('barcode'),
+    sa.UniqueConstraint('barcode')
+    )
+    op.create_table('statuses',
+    sa.Column('id', sa.Integer(), autoincrement=True, nullable=False),
+    sa.Column('name', sa.String(length=256), nullable=False),
+    sa.Column('description', sa.String(length=499), nullable=False),
+    sa.PrimaryKeyConstraint('id')
+    )
+    op.create_table('item_statuses',
+    sa.Column('item_barcode', sa.String(length=256), nullable=False),
+    sa.Column('status_id', sa.Integer(), nullable=False),
+    sa.Column('created_at', sa.DateTime(timezone=True), server_default=sa.text('now()'), nullable=False),
+    sa.ForeignKeyConstraint(['item_barcode'], ['items.barcode'], ),
+    sa.ForeignKeyConstraint(['status_id'], ['statuses.id'], ),
+    sa.PrimaryKeyConstraint('item_barcode', 'status_id')
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_table('item_statuses')
+    op.drop_table('statuses')
+    op.drop_table('items')
+    # ### end Alembic commands ###

aim/digifeeds/database/models.py

@@ -21,6 +21,10 @@ class Status(Base):
     description:  Mapped[str] = mapped_column(String(499))
     items: Mapped[list["ItemStatus"]] = relationship()
 
+    def __repr__(self):
+      return ( f'Status(id={self.id}, name={self.name}, description={self.description})')
+
+
 class ItemStatus(Base):
     __tablename__ = 'item_statuses'
     item_barcode: Mapped[int] = mapped_column(ForeignKey('items.barcode'), primary_key=True)
@@ -38,12 +42,23 @@ class ItemStatus(Base):
 
 
 def load_statuses(session: Session):
-    objects = [
-        Status(name="in_zephir", description="Item is in zephir"),
-        Status(name="added_to_digifeeds_set", description="Item has been added to the digifeeds set"),
-        Status(name="copying_start", description="The process for zipping and copying an item to the pickup location has started"),
-        Status(name="copying_end", description="The process for zipping and copying an item to the pickup location has completed successfully"),
-        Status(name="pending_deletion", description="The item has been copied to the pickup location and can be deleted upon ingest confirmation"),
+    statuses = [
+        {"name": "in_zephir", "description": "Item is in zephir"},
+        {"name": "added_to_digifeeds_set", "description": "Item has been added to the digifeeds set"},
+        {"name": "copying_start", "description": "The process for zipping and copying an item to the pickup location has started"},
+        {"name": "copying_end", "description": "The process for zipping and copying an item to the pickup location has completed successfully"},
+        {"name": "pending_deletion", "description": "The item has been copied to the pickup location and can be deleted upon ingest confirmation"},
+        {"name": "not_found_in_alma", "description": "Barcode wasn't found in Alma"},
     ]
+    objects = []
+    for status in statuses:
+        sts = session.query(Status).filter_by(name = status["name"]).first()
+        if sts == None:
+          objects.append(Status(**status))
+
+    print(f"Statuses to load: {objects}")
+
     session.bulk_save_objects(objects)
-    session.commit()
+    session.commit()
+
+    print("Statuses loaded.")