release v1.2.0

.github/workflows/ci.yml

@@ -15,6 +15,7 @@ jobs:
         python-version:
           - "3.11"
           - "3.12"
+          - "3.13"
     steps:
       - uses: actions/checkout@v4
       - name: Set up project using python ${{ matrix.python-version }}

.pre-commit-config.yaml

@@ -3,7 +3,7 @@
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.6.0
+    rev: v5.0.0
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
@@ -13,14 +13,14 @@ repos:
       - id: check-yaml
 
   - repo: https://github.com/asottile/pyupgrade
-    rev: v3.15.2
+    rev: v3.19.0
     hooks:
       - id: pyupgrade
         args:
         - --py311-plus
 
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: v0.3.6
+    rev: v0.7.1
     hooks:
       - id: ruff
         args:

docs/CHANGELOG.md

@@ -1,3 +1,21 @@
+## [1.2.0-rc.1](https://github.com/savannahghi/sghi-etl-core/compare/v1.1.1...v1.2.0-rc.1) (2024-10-28)
+
+
+### Dependency Updates
+
+* **deps:** upgrade project dependencies ([#19](https://github.com/savannahghi/sghi-etl-core/issues/19)) ([9074301](https://github.com/savannahghi/sghi-etl-core/commit/907430140ce14b32f5e05a04458bf62d5402fe9b))
+* **deps:** upgrade project dependencies ([#23](https://github.com/savannahghi/sghi-etl-core/issues/23)) ([ce00b54](https://github.com/savannahghi/sghi-etl-core/commit/ce00b548d96b30b4d0bba7b38245505809d85bfa))
+
+
+### Documentation Updates
+
+* **api:** minor docs fixes and updates ([#21](https://github.com/savannahghi/sghi-etl-core/issues/21)) ([857b43b](https://github.com/savannahghi/sghi-etl-core/commit/857b43b508b8078676cc172a303d28183f19ba19))
+
+
+### Features
+
+* **workflow:** add `prologue` and `epilogue` to `WorkflowDefinition` ([#22](https://github.com/savannahghi/sghi-etl-core/issues/22)) ([2c69085](https://github.com/savannahghi/sghi-etl-core/commit/2c69085a65fa5da32313b67294332f4de7b79c8d))
+
 ## [1.1.1](https://github.com/savannahghi/sghi-etl-core/compare/v1.1.0...v1.1.1) (2024-04-12)
 
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "sghi-etl-core",
-  "version": "1.1.1",
+  "version": "1.2.0-rc.1",
   "description": "API specification for components of a simple ETL workflow.",
   "directories": {
     "doc": "docs"

pyproject.toml

@@ -1,8 +1,8 @@
 [build-system]
 build-backend = "setuptools.build_meta"
 requires = [
-    "setuptools>=69.2.0",
-    "setuptools_scm>=8.0.4",
+    "setuptools~=75.2.0",
+    "setuptools_scm[toml]~=8.1.0",
 ]
 
 [project]
@@ -23,8 +23,8 @@ classifiers = [
     "Typing :: Typed"
 ]
 dependencies = [
-    "typing-extensions>=4.10.0",
-    "sghi-commons @ git+https://github.com/savannahghi/sghi-commons.git@v1.4.0",
+    "typing-extensions>=4.12.2",
+    "sghi-commons @ git+https://github.com/savannahghi/sghi-commons.git@v1.5.1",
 ]
 description = "API specification for components of a simple ETL workflow."
 dynamic = ["version"]
@@ -40,33 +40,33 @@ requires-python = ">=3.11" # Support Python 3.10+.
 
 [project.optional-dependencies]
 dev = [
-    "pre-commit~=3.7.0",
+    "pre-commit~=4.0.1",
 ]
 
 docs = [
-    "furo==2024.1.29",
-    "jaraco.packaging~=9.5.0",
-    "rst.linker~=2.4.0",
-    "Sphinx~=7.2.6",
+    "furo==2024.8.6",
+    "jaraco.packaging~=10.2.3",
+    "rst.linker~=2.6.0",
+    "Sphinx~=8.1.3",
     "sphinx-favicon~=1.0.1",
-    "sphinx-hoverxref~=1.3.0",
+    "sphinx-hoverxref~=1.4.1",
     "sphinx-inline-tabs~=2023.4.21",
-    "sphinx-lint~=0.9.1",
-    "sphinx-notfound-page~=1.0.0",
+    "sphinx-lint~=1.0.0",
+    "sphinx-notfound-page~=1.0.4",
 ]
 
 test = [
-    "coverage~=6.5.0",
-    "coveralls~=3.3.1",
+    "coverage~=7.6.4",
+    "coveralls~=4.0.1",
     "packaging",
-    "pyright>=1.1.358",
-    "pytest~=8.1.1",
+    "pyright>=1.1.386",
+    "pytest~=8.3.3",
     "pytest-cov~=5.0.0",
     "pytest-forked~=1.6.0",
     "pytest-sugar~=1.0.0",
-    "pytest-xdist~=3.5.0",
-    "ruff~=0.3.6",
-    "tox~=4.14.2",
+    "pytest-xdist~=3.6.1",
+    "ruff~=0.7.1",
+    "tox~=4.23.2",
     "tox-gh-actions~=3.2.0",
 ]
 
@@ -186,6 +186,7 @@ exclude = [
     "node_modules",
     "venv",
 ]
+indent-width = 4
 line-length = 79
 src = ["src", "test"]
 target-version = "py311"
@@ -198,48 +199,63 @@ skip-magic-trailing-comma = false
 
 [tool.ruff.lint]
 ignore = [
-    "ANN002",
-    "ANN003",
-    "ANN101",
-    "ANN102",
-    "ANN204",
-    "COM812",
-    "D203",
-    "D213",
-    "ISC001",
-    "S101",
+    "ANN101", # missing-type-self
+    "ANN102", # missing-type-cls
+    "COM812", # missing-trailing-comma
+    "D203",   # one-blank-line-before-class
+    "D213",   # multi-line-summary-second-line
+    "ISC001", # single-line-implicit-string-concatenation
+    "S101",   # assert - Use of assert detected
+    "TD003",  # missing-todo-link
 ]
 select = [
-    "A",   # flake8-builtins
-    "ANN", # flake8-annotations
-    "B",   # flake8-bugbear
-    "BLE", # flake8-blind-except
-    "C4",  # flake8-comprehensions
-    "C90", # mccabe
-    "COM", # flake8-commas
-    "D",   # pydocstyle
-    "E",   # pycodestyle Error
-    "EM",  # flake8-errmsg
-    "ERA", # eradicate
-    "F",   # pyflakes
-    "G",   # flake8-logging-format
-    "I",   # isort
-    "ISC", # flake8-implicit-str-concat
-    "N",   # pep8 Naming
-    "PD",  # pandas-vet
-    "PT",  # flake8-pytest-style
-    "PYI", # flake8-pyi
-    "Q",   # flake8-quotes
-    "RET", # flake8-return
-    "RUF", # Ruff-specific rules
-    "S",   # flake8-bandit
-    "SIM", # flake8-simplify
-    "T10", # flake8-debugger
-    "T20", # flake8-print
-    "TCH", # flake8-type-checking
-    "UP",  # pyupgrade
-    "W",   # pycodestyle Warning
-    "YTT", # flake8-2020
+    "A",     # flake8-builtins
+    "ANN",   # flake8-annotations
+    "ARG",   # flake8-unused-arguments
+    "ASYNC", # flake8-async
+    "B",     # flake8-bugbear
+    "BLE",   # flake8-blind-except
+    "C4",    # flake8-comprehensions
+    "C90",   # mccabe
+    "COM",   # flake8-commas
+    "D",     # pydocstyle
+    "DTZ",   # flake8-datetimez
+    "E",     # pycodestyle Error
+    "EM",    # flake8-errmsg
+    "ERA",   # eradicate
+    "EXE",   # flake8-executable
+    "F",     # pyflakes
+    "FA",    # flake8-future-annotations
+    "FBT",   # flake8-boolean-trap
+    "FLY",   # flynt
+    "FURB",  # refurb
+    "G",     # flake8-logging-format
+    "I",     # isort
+    "INT",   # flake8-gettext
+    "ISC",   # flake8-implicit-str-concat
+    "LOG",   # flake8-logging
+    "N",     # pep8 Naming
+    "PERF",  # Perflint
+    "PD",    # pandas-vet
+    "PL",    # Pylint
+    "PT",    # flake8-pytest-style
+    "PTH",   # flake8-use-pathlib
+    "PYI",   # flake8-pyi
+    "Q",     # flake8-quotes
+    "RET",   # flake8-return
+    "RUF",   # Ruff-specific rules
+    "S",     # flake8-bandit
+    "SIM",   # flake8-simplify
+    "SLOT",  # flake8-slots
+    "T10",   # flake8-debugger
+    "T20",   # flake8-print
+    "TCH",   # flake8-type-checking
+    "TD",    # flake8-todos
+    "TID",   # flake8-tidy-imports
+    "TRY",   # tryceratops
+    "UP",    # pyupgrade
+    "W",     # pycodestyle Warning
+    "YTT",   # flake8-2020
 ]
 
 [tool.ruff.lint.flake8-quotes]
@@ -263,6 +279,63 @@ where = ["src"]
 root = "."
 
 [tool.tox]
+env_list = ["{py311, py312, py313}", "coveralls", "docs", "package"]
+isolated_build = true
+requires = ["tox>=4.16", "tox-uv>=1.15.0"]
+no_package = false
+skip_missing_interpreters = true
+
+[tool.tox.env_run_base]
+# allowlist_externals = ["uv"]
+commands = [
+    ["ruff", "check", "."],
+    ["ruff", "format", "--check", "."],
+    ["pyright", "."],
+    ["coverage", "erase"],
+    ["pytest", { replace = "posargs", default = ["."], extend = true}],
+    ["coverage", "html"],
+]
+deps = ["."]
+description = "test and lint the project"
+download = true
+extras = ["test"]
+set_env ={ PYTHONPATH = "{toxinidir}/src", PYRIGHT_PYTHON_FORCE_VERSION = "latest" }
+
+[tool.tox.env.coveralls]
+# If running outside Github, ensure that the the `COVERALLS_REPO_TOKEN`
+# environment variable is set.
+commands = [["coveralls", "--service=github"]]
+description = "submit coverage results to coverall.io"
+extras = ["test"]
+pass_env = ["COVERALLS_REPO_TOKEN", "GITHUB_*"]
+
+[tool.tox.env.docs]
+changedir = "docs"
+commands = [
+    ["sphinx-build", "-EW", "--keep-going", "-b", "html", ".", "{toxinidir}/docs/build/html"],
+    ["sphinx-lint", "-i", "api"]
+]
+description = "build sphinx documentation"
+extras = ["docs"]
+
+[tool.tox.env.package]
+commands = [
+    ["python", "-c", "import shutil; shutil.rmtree('dist', ignore_errors=True)"],
+    ["python", "-m", "build"]
+]
+depends = ["testenv"]
+deps = ["build"]
+description = "build the library"
+skip_install = true
+
+[tool.tox.gh-actions]
+python = """
+   3.11: py311
+   3.12: py312, coveralls, docs, package
+   3.13: py313
+"""
+
+[tool.tox1]
 legacy_tox_ini = """
     [tox]
     env_list = {py311, py312}, coveralls, docs, package