V0.6.0 (#7)

.github/ISSUE_TEMPLATE/feat-request.md

@@ -0,0 +1,22 @@
+---
+name: Feature Request
+about: A new feature.
+title: "[FEAT] "
+labels: feat
+assignees: fmind
+body:
+- type: checkboxes
+  id: breaking-change
+  attributes:
+    label: Breaking change?
+    options:
+      - label: Yes
+      - label: No
+      - label: Maybe
+---
+
+## Description
+
+## Motivation
+
+## Solutions

.github/ISSUE_TEMPLATE/fix-request.md

@@ -1,23 +1,24 @@
 ---
-name: Fix request
-about: Request a fix for this project
+name: Fix Request
+about: A bug fix
 title: "[FIX] "
-labels: Fix
+labels: fix
 assignees: fmind
-
+body:
+- type: checkboxes
+  id: breaking-change
+  attributes:
+    label: Breaking change?
+    options:
+      - label: Yes
+      - label: No
+      - label: Maybe
 ---
 
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behavior:
+## Bug Description
 
-**Expected behavior**
-A clear and concise description of what you expected to happen.
+## Expected Behavior
 
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
+## Steps to Reproduce
 
-**Additional context**
-Add any other context about the problem here.
+## Additional Context

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,3 +1,9 @@
 # Changes
 
--
+# Reasons
+
+# Testing
+
+# Impacts
+
+# Notes

.github/workflows/on-pull-request.yml → .github/workflows/check.yml

@@ -1,3 +1,4 @@
+name: Check
 on:
   pull_request:
     branches:
@@ -11,5 +12,5 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - uses: ./.github/actions/setup
-      - run: poetry install --with dev,checks
+      - run: poetry install --with checks
       - run: poetry run invoke checks

.github/workflows/on-release-published.yml → .github/workflows/publish.yml

@@ -1,11 +1,12 @@
+name: Publish
 on:
   release:
     types: [published]
 env:
   DOCKER_IMAGE: ghcr.io/fmind/mlops-python-package:latest
 concurrency:
   cancel-in-progress: true
-  group: on-release-published
+  group: publish-workflow
 jobs:
   pages:
     runs-on: ubuntu-latest

.gitignore

@@ -2,6 +2,7 @@
 
 # Build
 /dist/
+/build/
 
 # Cache
 .cache/
@@ -16,7 +17,9 @@
 .ipynb_checkpoints/
 
 # Environs
+.env
 /.venv/
+poetry.lock
 
 # Project
 /docs/*

.pre-commit-config.yaml

@@ -1,5 +1,5 @@
-# See https://pre-commit.com for more information
-# See https://pre-commit.com/hooks.html for more hooks
+# https://pre-commit.com
+# https://pre-commit.com/hooks.html
 
 default_language_version:
   python: python3.12
@@ -13,15 +13,27 @@ repos:
       - id: check-merge-conflict
       - id: check-toml
       - id: check-yaml
+      - id: debug-statements
       - id: end-of-file-fixer
       - id: mixed-line-ending
       - id: trailing-whitespace
-  # project
-  - repo: local
+  - repo: github.com/PyCQA/bandit
+    rev: v1.7.7
     hooks:
-      - id: invoke-check
-        name: invoke checks
-        language: system
-        pass_filenames: false
-        verbose: true
-        entry: invoke checks
+      - id: bandit
+        args: ["--configfile=pyproject.toml"]
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.8.0
+    hooks:
+      - id: mypy
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.0
+    hooks:
+      - id: ruff
+      - id: ruff-format
+  - repo: https://github.com/commitizen-tools/commitizen
+    rev: v3.16.0
+    hooks:
+      - id: commitizen
+      - id: commitizen-branch
+        stages: [push]

Dockerfile

@@ -1,11 +1,6 @@
 # https://docs.docker.com/engine/reference/builder/
 
-# Define
 FROM python:3.12
-
-# Install
 COPY dist/*.whl .
-RUN pip install --no-cache-dir *.whl
-
-# Execute
+RUN pip install *.whl
 CMD ["bikes", "--help"]

README.md

@@ -1,10 +1,9 @@
 # MLOps Python Package
 
 [![on-release-published.yml](https://github.com/fmind/mlops-python-package/actions/workflows/on-release-published.yml/badge.svg)](https://github.com/fmind/mlops-python-package/actions/workflows/on-release-published.yml)
-[![Release](https://img.shields.io/github/v/release/fmind/mlops-python-package)](https://github.com/fmind/mlops-python-package/releases)
-
-[![License](https://img.shields.io/github/license/fmind/mlops-python-package)](https://github.com/fmind/mlops-python-package/blob/main/LICENCE.txt)
 [![Documentation](https://img.shields.io/badge/documentation-available-brightgreen.svg)](https://fmind.github.io/mlops-python-package/)
+[![License](https://img.shields.io/github/license/fmind/mlops-python-package)](https://github.com/fmind/mlops-python-package/blob/main/LICENCE.txt)
+[![Release](https://img.shields.io/github/v/release/fmind/mlops-python-package)](https://github.com/fmind/mlops-python-package/releases)
 
 This repository contains a Python package implementation designed to support MLOps initiatives.
 

docker-compose.yml

@@ -1,7 +1,8 @@
 # https://docs.docker.com/compose/compose-file/
+
 services:
   mlflow:
-    image: ghcr.io/mlflow/mlflow:v2.10.2
+    image: ghcr.io/mlflow/mlflow:v2.11.0
     ports:
       - 5000:5000
     environment:

mlops-python-package.code-workspace

@@ -22,9 +22,10 @@
 		"recommendations": [
 			"charliermarsh.ruff",
 			"dchanco.vsc-invoke",
+			"ms-python.mypy-type-checker",
 			"ms-python.python",
 			"ms-python.mypy-type-checker",
 			"ms-python.vscode-pylance",
 		]
 	}
-}
+}