feat(cruft): adopt cruft and link it to cookiecutter-mlops-package

BREAKING CHANGE:

Author: fmind

.cruft.json

@@ -0,0 +1,20 @@
+{
+  "template": "https://github.com/fmind/cookiecutter-mlops-package",
+  "commit": "00fef7106e4abd8ddc7a1625ebe7342fcb145f6c",
+  "checkout": null,
+  "context": {
+    "cookiecutter": {
+      "user": "fmind",
+      "name": "MLOps Python Package",
+      "repository": "mlops-python-package",
+      "package": "bikes",
+      "license": "MIT",
+      "version": "1.1.3",
+      "description": "Predict the number of bikes available",
+      "python_version": "3.12",
+      "mlflow_version": "2.14.3",
+      "_template": "https://github.com/fmind/cookiecutter-mlops-package"
+    }
+  },
+  "directory": null
+}

.github/FUNDING.yml

@@ -0,0 +1,4 @@
+# These are supported funding model platforms
+
+# github: ["MLOps-Courses"]
+custom: ["https://donate.stripe.com/4gw8xT9oVbCc98s7ss"]

LICENCE.txt

@@ -12,7 +12,9 @@ The package leverages several [tools](#tools) and [tips](#tips) to make your MLO
 
 You can use this package as part of your MLOps toolkit or platform (e.g., Model Registry, Experiment Tracking, Realtime Inference, ...).
 
-**NEW: Check the [MLOps Coding Course](https://mlops-coding-course.fmind.dev/) to learn how to create and use this package for your projects: https://github.com/MLOps-Courses/mlops-coding-course.**
+**Related Resources**:
+- **[MLOps Coding Course (Learning)](https://github.com/MLOps-Courses/mlops-coding-course)**: Learn how to create, develop, and maintain a state-of-the-art MLOps code base.
+- **[Cookiecutter MLOps Package (Template)](https://github.com/fmind/cookiecutter-mlops-package)**: Start building and deploying Python packages and Docker images for MLOps tasks.
 
 # Table of Contents
 

README.md

@@ -2,7 +2,7 @@
 
 services:
   mlflow:
-    image: ghcr.io/mlflow/mlflow:v2.14.1
+    image: ghcr.io/mlflow/mlflow:v2.14.3
     ports:
       - 5000:5000
     environment:

docker-compose.yml

@@ -4,3 +4,5 @@ run:
   echo: true
 project:
   name: bikes
+  package: bikes
+  repository: bikes

invoke.yaml

@@ -10,7 +10,7 @@ repository = "https://github.com/fmind/mlops-python-package"
 documentation = "https://fmind.github.io/mlops-python-package/"
 authors = ["Médéric HURIER <github@fmind.dev>"]
 readme = "README.md"
-license = "CC BY"
+license = "MIT"
 keywords = ["mlops", "python", "package"]
 packages = [{ include = "bikes", from = "src" }]
 

pyproject.toml

@@ -1,90 +1,93 @@
-python: '3.12'
-dependencies:
-- alembic==1.13.2
-- aniso8601==9.0.1
-- annotated-types==0.7.0
-- antlr4-python3-runtime==4.9.3
-- blinker==1.8.2
-- cachetools==5.4.0
-- certifi==2024.7.4
-- charset-normalizer==3.3.2
-- click==8.1.7
-- cloudpickle==3.0.0
-- colorama==0.4.6
-- contourpy==1.2.1
-- cycler==0.12.1
-- deprecated==1.2.14
-- docker==7.1.0
-- entrypoints==0.4
-- flask==3.0.3
-- fonttools==4.53.1
-- gitdb==4.0.11
-- gitpython==3.1.43
-- graphene==3.3
-- graphql-core==3.2.3
-- graphql-relay==3.2.0
-- greenlet==3.0.3
-- gunicorn==22.0.0
-- idna==3.7
-- importlib-metadata==7.2.1
-- itsdangerous==2.2.0
-- jinja2==3.1.4
-- joblib==1.4.2
-- kiwisolver==1.4.5
-- llvmlite==0.43.0
-- loguru==0.7.2
-- mako==1.3.5
-- markdown==3.6
-- markupsafe==2.1.5
-- matplotlib==3.9.1
-- mlflow==2.14.3
-- multimethod==1.10
-- mypy-extensions==1.0.0
-- numba==0.60.0
-- numpy==1.26.4
-- omegaconf==2.3.0
-- opentelemetry-api==1.26.0
-- opentelemetry-sdk==1.26.0
-- opentelemetry-semantic-conventions==0.47b0
-- packaging==24.1
-- pandas==2.2.2
-- pandera==0.20.3
-- pillow==10.4.0
-- plotly==5.23.0
-- plyer==2.1.0
-- protobuf==4.25.4
-- psutil==6.0.0
-- pyarrow==15.0.2
-- pydantic-core==2.20.1
-- pydantic-settings==2.3.4
-- pydantic==2.8.2
-- pynvml==11.5.3
-- pyparsing==3.1.2
-- python-dateutil==2.9.0.post0
-- python-dotenv==1.0.1
-- pytz==2024.1
-- pyyaml==6.0.1
-- querystring-parser==1.2.4
-- requests==2.32.3
-- scikit-learn==1.4.2
-- scipy==1.14.0
-- setuptools==71.1.0
-- shap==0.46.0
-- six==1.16.0
-- slicer==0.0.8
-- smmap==5.0.1
-- sqlalchemy==2.0.31
-- sqlparse==0.5.1
-- tenacity==8.5.0
-- threadpoolctl==3.5.0
-- tqdm==4.66.4
-- typeguard==4.3.0
-- typing-extensions==4.12.2
-- typing-inspect==0.9.0
-- tzdata==2024.1
-- urllib3==2.2.2
-- waitress==3.0.0
-- werkzeug==3.0.3
-- win32-setctime==1.1.0
-- wrapt==1.16.0
-- zipp==3.19.2
+{
+    "python": "3.12",
+    "dependencies": [
+        "alembic==1.13.2",
+        "aniso8601==9.0.1",
+        "annotated-types==0.7.0",
+        "antlr4-python3-runtime==4.9.3",
+        "blinker==1.8.2",
+        "cachetools==5.4.0",
+        "certifi==2024.7.4",
+        "charset-normalizer==3.3.2",
+        "click==8.1.7",
+        "cloudpickle==3.0.0",
+        "colorama==0.4.6",
+        "contourpy==1.2.1",
+        "cycler==0.12.1",
+        "deprecated==1.2.14",
+        "docker==7.1.0",
+        "entrypoints==0.4",
+        "flask==3.0.3",
+        "fonttools==4.53.1",
+        "gitdb==4.0.11",
+        "gitpython==3.1.43",
+        "graphene==3.3",
+        "graphql-core==3.2.3",
+        "graphql-relay==3.2.0",
+        "greenlet==3.0.3",
+        "gunicorn==22.0.0",
+        "idna==3.7",
+        "importlib-metadata==7.2.1",
+        "itsdangerous==2.2.0",
+        "jinja2==3.1.4",
+        "joblib==1.4.2",
+        "kiwisolver==1.4.5",
+        "llvmlite==0.43.0",
+        "loguru==0.7.2",
+        "mako==1.3.5",
+        "markdown==3.6",
+        "markupsafe==2.1.5",
+        "matplotlib==3.9.1",
+        "mlflow==2.14.3",
+        "multimethod==1.10",
+        "mypy-extensions==1.0.0",
+        "numba==0.60.0",
+        "numpy==1.26.4",
+        "omegaconf==2.3.0",
+        "opentelemetry-api==1.26.0",
+        "opentelemetry-sdk==1.26.0",
+        "opentelemetry-semantic-conventions==0.47b0",
+        "packaging==24.1",
+        "pandas==2.2.2",
+        "pandera==0.20.3",
+        "pillow==10.4.0",
+        "plotly==5.23.0",
+        "plyer==2.1.0",
+        "protobuf==4.25.4",
+        "psutil==6.0.0",
+        "pyarrow==15.0.2",
+        "pydantic-core==2.20.1",
+        "pydantic-settings==2.3.4",
+        "pydantic==2.8.2",
+        "pynvml==11.5.3",
+        "pyparsing==3.1.2",
+        "python-dateutil==2.9.0.post0",
+        "python-dotenv==1.0.1",
+        "pytz==2024.1",
+        "pyyaml==6.0.1",
+        "querystring-parser==1.2.4",
+        "requests==2.32.3",
+        "scikit-learn==1.4.2",
+        "scipy==1.14.0",
+        "setuptools==71.1.0",
+        "shap==0.46.0",
+        "six==1.16.0",
+        "slicer==0.0.8",
+        "smmap==5.0.1",
+        "sqlalchemy==2.0.31",
+        "sqlparse==0.5.1",
+        "tenacity==8.5.0",
+        "threadpoolctl==3.5.0",
+        "tqdm==4.66.4",
+        "typeguard==4.3.0",
+        "typing-extensions==4.12.2",
+        "typing-inspect==0.9.0",
+        "tzdata==2024.1",
+        "urllib3==2.2.2",
+        "waitress==3.0.0",
+        "werkzeug==3.0.3",
+        "win32-setctime==1.1.0",
+        "wrapt==1.16.0",
+        "zipp==3.19.2"
+    ]
+}

python_env.yaml

@@ -23,13 +23,13 @@ def compose(ctx: Context) -> None:
 @task(pre=[packages.build])
 def build(ctx: Context, tag: str = IMAGE_TAG) -> None:
     """Build the container image."""
-    ctx.run(f"docker build --tag={ctx.project.name}:{tag} .")
+    ctx.run(f"docker build --tag={ctx.project.repository}:{tag} .")
 
 
 @task
 def run(ctx: Context, tag: str = IMAGE_TAG) -> None:
     """Run the container image."""
-    ctx.run(f"docker run --rm {ctx.project.name}:{tag}")
+    ctx.run(f"docker run --rm {ctx.project.repository}:{tag}")
 
 
 @task(pre=[build, run], default=True)

tasks/containers.py

@@ -18,14 +18,14 @@
 @task
 def serve(ctx: Context, format: str = DOC_FORMAT, port: int = 8088) -> None:
     """Serve the API docs with pdoc."""
-    ctx.run(f"poetry run pdoc --docformat={format} --port={port} src/{ctx.project.name}")
+    ctx.run(f"poetry run pdoc --docformat={format} --port={port} src/{ctx.project.package}")
 
 
 @task
 def api(ctx: Context, format: str = DOC_FORMAT, output_dir: str = OUTPUT_DIR) -> None:
     """Generate the API docs with pdoc."""
     ctx.run(
-        f"poetry run pdoc --docformat={format} --output-directory={output_dir} src/{ctx.project.name}"
+        f"poetry run pdoc --docformat={format} --output-directory={output_dir} src/{ctx.project.package}"
     )