V4.0.0 (#45)

Author: fmind

.cruft.json

@@ -9,10 +9,10 @@
       "repository": "mlops-python-package",
       "package": "bikes",
       "license": "MIT",
-      "version": "1.1.3",
+      "version": "4.0.0",
       "description": "Predict the number of bikes available",
-      "python_version": "3.12",
-      "mlflow_version": "2.14.3",
+      "python_version": "3.13",
+      "mlflow_version": "2.20.3",
       "_template": "https://github.com/fmind/cookiecutter-mlops-package"
     }
   },

docs/.gitkeep renamed to .env.example

@@ -4,7 +4,7 @@ runs:
   using: composite
   steps:
     - name: Install uv
-      uses: astral-sh/setup-uv@v4
+      uses: astral-sh/setup-uv@v5
       with:
         enable-cache: true
     - name: Setup Python

.github/actions/setup/action.yml

@@ -12,9 +12,9 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - uses: ./.github/actions/setup
-      - run: uv sync --group=checks
-      - run: uv run invoke checks.format
-      - run: uv run invoke checks.type
-      - run: uv run invoke checks.code
-      - run: uv run invoke checks.security
-      - run: uv run invoke checks.coverage
+      - run: uv sync --group=check
+      - run: uv run just check-code
+      - run: uv run just check-type
+      - run: uv run just check-format
+      - run: uv run just check-security
+      - run: uv run just check-coverage

.github/workflows/check.yml

@@ -15,8 +15,8 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - uses: ./.github/actions/setup
-      - run: uv sync --group=docs
-      - run: uv run invoke docs
+      - run: uv sync --group=doc
+      - run: uv run just docs
       - uses: JamesIves/github-pages-deploy-action@v4
         with:
           folder: docs/
@@ -29,7 +29,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: ./.github/actions/setup
       - run: uv sync --only-dev
-      - run: uv run invoke packages
+      - run: uv run just packages
       - uses: docker/login-action@v3
         with:
           registry: ghcr.io

.github/workflows/publish.yml

@@ -2,10 +2,10 @@
 # https://pre-commit.com/hooks.html
 
 default_language_version:
-  python: python3.12
+  python: python3.13
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
+    rev: 'v5.0.0'
     hooks:
       - id: check-added-large-files
       - id: check-case-conflict
@@ -17,12 +17,16 @@ repos:
       - id: mixed-line-ending
       - id: trailing-whitespace
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.8.1
+    rev: 'v0.9.9'
     hooks:
       - id: ruff
       - id: ruff-format
+  - repo: https://github.com/PyCQA/bandit
+    rev: '1.8.3'
+    hooks:
+    - id: bandit
   - repo: https://github.com/commitizen-tools/commitizen
-    rev: v4.0.0
+    rev: 'v4.4.1'
     hooks:
       - id: commitizen
       - id: commitizen-branch

.pre-commit-config.yaml

@@ -1 +1 @@
-3.12
+3.13

.python-version

@@ -1,22 +1,20 @@
-## v3.0.0 (2024-12-14)
+## v4.0.0 (2025-03-04)
 
 ### Feat
 
-- **mlflow**: bump to 2.19.0
-- **manager**: switch from poetry to uv (#22)
-- **manager**: switch from poetry to uv
+- **tasks**: switch from pyinvoke to just (#42)
+- **workflows**: bump GitHub action versions (#41)
+- **versions**: bump python and package version (#40)
+- **mindmap**: add mindmap of the package (#32)
 
 ### Fix
 
-- **tasks**: merge conflict
-- **tasks**: fix mlflow.serve task attribute
-- **github-actions**: run check on all PR
+- **version**: ready to bump
+- **datasets**: fix dtype backend (#44)
 
 ### Refactor
 
-- **release**: prepare before release
-- **actions**: split check tasks into subtask for easier debugging (#29)
-- **code**: improve abstractions (#28)
+- **cruft**: update to new template version
 
 ## v2.0.0 (2024-07-28)
 
@@ -42,32 +40,6 @@
 
 - **publish**: fix publication workflow by installing dev dependencies
 
-## v1.1.0 (2024-07-21)
-
-### Feat
-
-- **kpi**: add key performance indicators
-- **mlproject**: add mlflow project and tasks
-- **monitoring**: add mlflow.evaluate API
-- **lineage**: add lineage features through mlflow data api
-- **explanations**: add explainability features and tooling
-- **data**: add train, test, and sample data
-- **notification**: add service and alerts with plyer
-- **observability**: add alerting with plyer notifications
-- **observability**: add infrastructure through mlflow system metrics
-
-### Fix
-
-- **kpi**: add key performance indicators
-- **projects**: change naming convention
-- **evaluation**: add evaluation files
-- **loading**: use version or alias for loading models
-- **warnings**: improve styles and remove warnings
-- **mlflow**: remove input examples following the addition of lineage
-- **paths**: fix path for explanation job
-- **data**: fix models explanations name
-- **data**: add parquet data
-
 ## v1.0.1 (2024-06-28)
 
 ### Fix

CHANGELOG.md

@@ -1,6 +1,6 @@
 # https://docs.docker.com/engine/reference/builder/
 
-FROM ghcr.io/astral-sh/uv:python3.12-bookworm
+FROM ghcr.io/astral-sh/uv:python3.13-bookworm
 COPY dist/*.whl .
 RUN uv pip install --system *.whl
 CMD ["bikes", "--help"]

Dockerfile

@@ -36,7 +36,7 @@ You can use this package as part of your MLOps toolkit or platform (e.g., Model
   - [Automation](#automation-1)
     - [Commits: Commitizen](#commits-commitizen)
     - [Git Hooks: Pre-Commit](#git-hooks-pre-commit)
-    - [Tasks: PyInvoke](#tasks-pyinvoke)
+    - [Tasks: Just](#tasks-just)
   - [CI/CD](#cicd)
     - [Runner: GitHub Actions](#runner-github-actions)
   - [CLI](#cli)
@@ -76,7 +76,7 @@ You can use this package as part of your MLOps toolkit or platform (e.g., Model
     - [Runtime: Docker](#runtime-docker)
   - [Programming](#programming)
     - [Language: Python](#language-python)
-    - [Version: Pyenv](#version-pyenv)
+    - [Version: Uv](#version-uv)
   - [Observability](#observability)
     - [Reproducibility: Mlflow Project](#reproducibility-mlflow-project)
     - [Monitoring : Mlflow Evaluate](#monitoring--mlflow-evaluate)
@@ -121,7 +121,7 @@ This section details the requirements, actions, and next steps to kickstart your
 
 ## Prerequisites
 
-- [Python>=3.12](https://www.python.org/downloads/): to benefit from [the latest features and performance improvements](https://docs.python.org/3/whatsnew/3.12.html)
+- [Python>=3.13](https://www.python.org/downloads/): to benefit from [the latest features and performance improvements](https://docs.python.org/3/whatsnew/3.13.html)
 - [uv>=0.5.5](https://docs.astral.sh/uv/): to initialize the project [virtual environment](https://docs.python.org/3/library/venv.html) and its dependencies
 
 ## Installation
@@ -220,71 +220,90 @@ with job as runner:
 
 This project includes several automation tasks to easily repeat common actions.
 
-You can invoke the actions from the [command-line](https://www.pyinvoke.org/) or [VS Code extension](https://marketplace.visualstudio.com/items?itemName=dchanco.vsc-invoke).
+You can invoke the actions from the [command-line](https://just.systems/man/en/introduction.html) or [VS Code extension](https://marketplace.visualstudio.com/items?itemName=nefrob.vscode-just-syntax).
 
 ```bash
 # execute the project DAG
-$ inv projects
+$ just project
 # create a code archive
-$ inv packages
+$ just package
 # list other actions
-$ inv --list
+$ just
 ```
 
 **Available tasks**:
-- **checks.all (checks)** - Run all check tasks.
-- **checks.code** - Check the codes with ruff.
-- **checks.coverage** - Check the coverage with coverage.
-- **checks.format** - Check the formats with ruff.
-- **checks.security** - Check the security with bandit.
-- **checks.test** - Check the tests with pytest.
-- **checks.type** - Check the types with mypy.
-- **cleans.all (cleans)** - Run all tools and folders tasks.
-- **cleans.cache** - Clean the cache folder.
-- **cleans.coverage** - Clean the coverage tool.
-- **cleans.dist** - Clean the dist folder.
-- **cleans.docs** - Clean the docs folder.
-- **cleans.environment** - Clean the project environment file.
-- **cleans.folders** - Run all folders tasks.
-- **cleans.mlruns** - Clean the mlruns folder.
-- **cleans.mypy** - Clean the mypy tool.
-- **cleans.outputs** - Clean the outputs folder.
-- **cleans.projects** - Run all projects tasks.
-- **cleans.pytest** - Clean the pytest tool.
-- **cleans.python** - Clean python caches and bytecodes.
-- **cleans.requirements** - Clean the project requirements file.
-- **cleans.reset** - Run all tools, folders, and sources tasks.
-- **cleans.ruff** - Clean the ruff tool.
-- **cleans.sources** - Run all sources tasks.
-- **cleans.tools** - Run all tools tasks.
-- **cleans.uv** - Clean uv lock file.
-- **cleans.venv** - Clean the venv folder.
-- **commits.all (commits)** - Run all commit tasks.
-- **commits.bump** - Bump the version of the package.
-- **commits.commit** - Commit all changes with a message.
-- **commits.info** - Print a guide for messages.
-- **containers.all (containers)** - Run all container tasks.
-- **containers.build** - Build the container image with the given tag.
-- **containers.compose** - Start up docker compose.
-- **containers.run** - Run the container image with the given tag.
-- **docs.all (docs)** - Run all docs tasks.
-- **docs.api** - Document the API with pdoc using the given format and output directory.
-- **docs.serve** - Serve the API docs with pdoc using the given format and computer port.
-- **formats.all** - (formats) Run all format tasks.
-- **formats.imports** - Format python imports with ruff.
-- **formats.sources** - Format python sources with ruff.
-- **installs.all (installs)** - Run all install tasks.
-- **installs.pre-commit** - Install pre-commit hooks on git.
-- **installs.uv** - Install uv packages.
-- **mlflow.all (mlflow)** - Run all mlflow tasks.
-- **mlflow.doctor** - Run mlflow doctor to diagnose issues.
-- **mlflow.serve** - Start mlflow server with the given host, port, and backend uri.
-- **packages.all (packages)** - Run all package tasks.
-- **packages.build** - Build a python package with the given format.
-- **projects.all (projects)** - Run all project tasks.
-- **projects.environment** - Export the project environment file.
-- **projects.requirements** - Export the project requirements file.
-- **projects.run** - Run an mlflow project from MLproject file.
+
+```toml
+default # display help information
+
+[check]
+check # run check tasks
+check-code # check code quality
+check-coverage numprocesses="auto" cov_fail_under="80" # check code coverage
+check-format # check code format
+check-security # check code security
+check-test numprocesses="auto" # check unit tests
+check-type # check code typing
+
+[clean]
+clean # run clean tasks
+clean-build # clean build folders
+clean-cache # clean cache folder
+clean-constraints # clean constraints file
+clean-coverage # clean coverage files
+clean-docs # clean docs folder
+clean-environment # clean environment file
+clean-mlruns # clean mlruns folder
+clean-mypy # clean mypy folders
+clean-outputs # clean outputs folder
+clean-pytest # clean pytest cache
+clean-python # clean python caches
+clean-requirements # clean requirements file
+clean-ruff # clean ruff cache
+clean-venv # clean venv folder
+
+[commit]
+commit-bump # bump package
+commit-files # commit package
+commit-info # get commit info
+
+[doc]
+doc # run doc tasks
+doc-build format="google" output="docs" # build documentation
+doc-serve format="google" port="8088" # serve documentation
+
+[docker]
+docker # run docker tasks
+docker-build tag="latest" # build docker image
+docker-compose # start docker compose
+docker-run tag="latest" # run latest docker image
+
+[format]
+format # run format tasks
+format-import # format code import
+format-source # format code source
+
+[install]
+install # run install tasks
+install-hooks # install git hooks
+install-project # install the project
+
+[mlflow]
+mlflow # run mlflow tasks
+mlflow-doctor # run mlflow doctor
+mlflow-serve host="127.0.0.1" port="5000" uri="./mlruns" # start mlflow server
+
+[package]
+package # run package tasks
+package-build constraints="constraints.txt" # build python package
+package-constraints constraints="constraints.txt" # build package constraints
+
+[project]
+project # run project tasks
+project-environment # export environment file
+project-requirements # export requirements file
+project-run job # run project job using mlflow
+```
 
 ## Workflows
 
@@ -324,16 +343,17 @@ Pre-defined actions to automate your project development.
 - **Alternatives**:
   - [Git Hooks](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks): less convenient to use
 
-### Tasks: [PyInvoke](https://www.pyinvoke.org/)
+### Tasks: [Just](https://just.systems/man/en/introduction.html)
 
 - **Motivations**:
   - Automate project workflows
   - Sane syntax compared to alternatives
-  - Good trade-off between power/simplicity
+  - Good trade-off between power and simplicity
 - **Limitations**:
   - Not familiar to most developers
 - **Alternatives**:
   - [Make](https://www.gnu.org/software/make/manual/make.html): most popular, but awful syntax
+  - [PyInvoke](https://www.pyinvoke.org/): pythonic, but verbose and less straightforward.
 
 ## CI/CD
 
@@ -581,8 +601,8 @@ Generate and share the project documentations.
 - **Limitations**:
   - Only support API docs (i.e., no custom docs)
 - **Alternatives**:
-  - [Sphinx](https://www.sphinx-doc.org/en/master/): Most complete, overkill for simple projects
-  - [Mkdocs](https://www.mkdocs.org/): no support for API doc, which is the core feature
+  - [Sphinx](https://www.sphinx-doc.org/en/master/): More complete, overkill for simple projects
+  - [Mkdocs](https://www.mkdocs.org/): More complete, but requires more setup
 
 ### Format: [Google](https://google.github.io/styleguide/pyguide.html)
 
@@ -727,7 +747,7 @@ Select your programming environment.
   - [R](https://www.r-project.org/): specific purpose language
   - [Julia](https://julialang.org/): specific purpose language
 
-### Version: [Pyenv](https://github.com/pyenv/pyenv)
+### Version: [Uv](https://docs.astral.sh/uv/guides/install-python/)
 
 - **Motivations**:
   - Switch between Python version
@@ -737,6 +757,7 @@ Select your programming environment.
   - Require some shell configurations
 - **Alternatives**:
   - Manual installation: time consuming
+  - [PyEnv](https://github.com/pyenv/pyenv): shell-based, require more setup
 
 ## Observability