Merge pull request #320 from nsidc/add-db-migrations

Add db migrations

CHANGELOG.md

@@ -1,6 +1,11 @@
+## v2.1.0 (2024-09-26)
+
+* Increase length of description columns to 4096 chars.
+
+
 ## v2.0.2 (2024-06-07)
 
-* Change all sankey nodes to gray color
+* Change all sankey nodes to gray color.
 
 
 ## v2.0.1 (2024-03-21)

CITATION.cff

@@ -10,8 +10,8 @@ type: "software"
 # https://github.com/zenodo/zenodo/issues/2515
 license: "MIT"
 
-version: 2.0.2
-date-released: "2024-06-07"
+version: 2.1.0
+date-released: "2024-09-26"
 url: "https://github.com/nsidc/usaon-benefit-tool"
 
 authors:

Dockerfile

@@ -19,10 +19,12 @@ RUN micromamba install -y \
 
 
 # Install source
+COPY ./usaon_benefit_tool ./usaon_benefit_tool
 COPY ./pyproject.toml .
 COPY ./tasks ./tasks
 COPY ./scripts ./scripts
-COPY ./usaon_benefit_tool ./usaon_benefit_tool
+COPY ./migrations ./migrations
+COPY ./alembic.ini .
 
 ENV FLASK_APP=usaon_benefit_tool
 

VERSION.env

@@ -1 +1 @@
-export USAON_BENEFIT_TOOL_VERSION="v2.0.2"
+export USAON_BENEFIT_TOOL_VERSION="v2.1.0"

alembic.ini

@@ -0,0 +1,118 @@
+# 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 = newline
+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
+
+# IMPORTANT: Populated in env.py dynamically
+sqlalchemy.url = fakeurl
+
+
+[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

compose.dev.yml

@@ -31,6 +31,7 @@ services:
  user: "root"
  volumes:
  - "./usaon_benefit_tool:/usaon-benefit-tool/usaon_benefit_tool:ro"
+ - "./migrations:/usaon-benefit-tool/migrations:rw"
  - "./tasks:/usaon-benefit-tool/tasks:ro"
  ports:
  - "5000:5000"