V0.4.0 (#4)

Author: fmind

.github/ISSUE_TEMPLATE.md

@@ -1,16 +1,14 @@
-## Expected Behavior
-
-
 ## Actual Behavior
 
+## Expected Behavior
 
-## Steps to Reproduce the Problem
+## Steps to Reproduce
 
 1.
 1.
 1.
 
-## Specifications
+## System Specifications
 
 - Version:
 - Platform:

.github/PULL_REQUEST_TEMPLATE.md

@@ -2,6 +2,4 @@ Fixes #
 
 ## Proposed Changes
 
--
--
 -

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

@@ -11,5 +11,5 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - uses: ./.github/actions/setup
-      - run: poetry install --with dev,checks,formats
+      - run: poetry install --with dev,checks
       - run: poetry run invoke checks

.gitignore

@@ -7,6 +7,7 @@
 .cache/
 .coverage*
 .mypy_cache/
+.ruff_cache/
 .pytest_cache/
 
 # Editor

.pre-commit-config.yaml

@@ -6,7 +6,7 @@ default_language_version:
 repos:
   # commons
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.5.0
     hooks:
       - id: check-added-large-files
       - id: check-case-conflict

LICENCE.txt

@@ -1,5 +1,11 @@
 # 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/)
+
 This repository contains a Python package implementation designed to support MLOps initiatives.
 
 The package uses several [tools](#tools) and [tips](#tips) to make your MLOps experience as flexible, robust, productive as possible.

README.md

@@ -15,19 +15,15 @@
 			"editor.codeActionsOnSave": {
 				"source.organizeImports": "explicit"
 			},
-			"editor.defaultFormatter": "ms-python.black-formatter"
+			"editor.defaultFormatter": "charliermarsh.ruff",
 		},
 	},
 	"extensions": {
 		"recommendations": [
+			"charliermarsh.ruff",
 			"dchanco.vsc-invoke",
-			"ms-python.black-formatter",
-			"ms-python.isort",
-			"ms-python.mypy-type-checker",
-			"ms-python.pylint",
 			"ms-python.python",
 			"ms-python.vscode-pylance",
-			"redhat.vscode-yaml",
 		]
 	}
-}
+}