chore: turn repo into Cookiecutter template with pre-commit wiring and templated files

Author: asq-sheriff

.pre-commit-config.yaml

@@ -4,5 +4,11 @@
   "author_name": "Your Name",
   "author_email": "[email protected]",
   "description": "A short description of the project",
-  "python_version": "3.11"
+  "python_version": "3.11",
+  "pre_commit_hooks_rev": "v5.0.0",
+  "ruff_pre_commit_rev": "v0.11.9",
+  "mypy_rev": "v1.15.0",
+  "bandit_rev": "1.8.3",
+  "commitizen_rev": "v4.7.0",
+  "docformatter_rev": "v1.7.7"
 }

README.md

@@ -1,17 +1,24 @@
-# Core development tools
-pip install \
-    ruff \
-    mypy \
-    pytest pytest-cov pytest-asyncio \
-    pre-commit \
-    pip-tools \
-    commitizen
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
 
-# Additional utilities (optional but recommended)
-pip install \
-    bandit \
-    safety \
-    prettier \
-    autopep8 \
-    docformatter \
-    types-requests types-setuptools
+[project]
+name = "{{ cookiecutter.project_slug }}"
+version = "0.1.0"
+description = "{{ cookiecutter.description }}"
+authors = [{ name = "{{ cookiecutter.author_name }}", email = "{{ cookiecutter.author_email }}" }]
+readme = "README.md"
+requires-python = ">= {{ cookiecutter.python_version }}"
+dependencies = [
+    # Add your project dependencies here
+]
+
+[project.optional-dependencies]
+dev = [
+    "pre-commit>=4.4.0",  # Git hooks manager
+    "ruff>=0.11.9",       # Linter/formatter
+    "mypy>=1.15.0",       # Static type checker
+    "bandit>=1.8.3",      # Security linter
+    "docformatter>=1.7.7",# Docstring formatter
+    "commitizen>=4.7.0"   # Conventional commits
+]

cookiecutter.json

@@ -0,0 +1,11 @@
+"""
+Core functionality for {{ cookiecutter.project_name }}.
+"""
+
+def greet(name: str) -> str:
+    """Return a greeting for the given name."""
+    return f"Hello, {name}!"
+
+if __name__ == "__main__":
+    # Example entry point
+    print(greet("World"))

pyproject.toml

@@ -0,0 +1,16 @@
+"""
+Command-line interface for {{ cookiecutter.project_name }} using Typer.
+"""
+import typer
+from {{ cookiecutter.project_slug }}.main import greet
+
+app = typer.Typer()
+
+@app.command()
+def hello(name: str):
+    """Greet someone by name."""
+    typer.echo(greet(name))
+
+
+if __name__ == "__main__":
+    app()

src/{{cookiecutter.project_slug}}/__init__.py

@@ -0,0 +1,39 @@
+from rich import print
+from rich.panel import Panel
+from rich.table import Table
+
+# Project metadata
+my_dict = {
+    "project_name": "{{ cookiecutter.project_name }}",
+    "project_slug": "{{ cookiecutter.project_slug }}",
+    "author": "{{ cookiecutter.author_name }}",
+    "description": "{{ cookiecutter.description }}",
+    "python_version": "{{ cookiecutter.python_version }}"
+}
+
+# Sample data
+my_list = [1, "apple", {"key": "value"}, True, None, 3.14]
+
+print("--- Rich Printing ---")
+print(my_dict)
+print(my_list)
+
+# Welcome panel
+print(Panel(
+    f"Hello, [bold magenta]{{ cookiecutter.project_name }}[/]!",
+    title="[bold green]Welcome to {{ cookiecutter.project_name }}[/]",
+    subtitle="Generated by Cookiecutter"
+))
+
+# Task overview table
+table = Table(title="{{ cookiecutter.project_name }} Task Overview")
+
+table.add_column("ID", style="dim", width=6)
+table.add_column("Task Name")
+table.add_column("Status", justify="right")
+
+table.add_row("1", "Initialize Repository", "[green]Done[/]")
+table.add_row("2", "Configure Pre-commit Hooks", "[yellow]In Progress[/]")
+table.add_row("3", "Start Development", "[red]Pending[/]")
+
+print(table)

src/{{cookiecutter.project_slug}}/main.py

@@ -1,5 +1,10 @@
-# tests/test_main.py
-from src.my_package.main import greet
+"""
+Test suite for the greeting functionality.
+"""
+import pytest
+from {{ cookiecutter.project_slug }}.main import greet
+
 
 def test_greet():
-    assert greet("Developer") == "Hello, Developer"
+    """Ensure greet returns the expected string with an exclamation."""
+    assert greet("Developer") == "Hello, Developer!"