Initial project setup with linting, testing, and git hooks

Author: currantw

.gitignore

@@ -0,0 +1,23 @@
+# Python
+__pycache__/
+*.py[cod]
+
+# Virtual environments
+venv/
+.venv/
+
+# Testing & Coverage
+.pytest_cache/
+.coverage/
+
+# Type checking & Linting
+.mypy_cache/
+.ruff_cache/
+
+# IDE
+.vscode/
+.idea/
+*.swp
+
+# macOS
+.DS_Store

.pre-commit-config.yaml

@@ -0,0 +1,35 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+      - id: check-merge-conflict
+      - id: debug-statements
+      - id: check-docstring-first
+
+  - repo: local
+    hooks:
+      - id: check-bare-todos
+        name: Check for bare TODOs
+        entry: '(TODO|FIXME|XXX)(?!.*:)'
+        language: pygrep
+        files: \.(py|md|txt|yaml|yml)$
+        exclude: ^\.pre-commit-config\.yaml$
+        description: 'Prevent bare TODOs without context (use "TODO: description" instead)'
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.1.6
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.5.1
+    hooks:
+      - id: mypy
+        additional_dependencies: [pytest]
+        args: [--strict]

Makefile

@@ -0,0 +1,57 @@
+.PHONY: help install install-dev check-format fix-format check-lint fix-lint check-type check-all fix-all test test-cov clean pre-commit
+
+help:  ## Show this help message
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'
+
+# Install dependencies
+install:
+	pip install -r requirements.txt
+
+install-dev:
+	pip install -r requirements.txt
+	pip install -r requirements-dev.txt
+	pre-commit install
+
+# Check code quality
+check-format:
+	ruff format --check --diff .
+
+check-lint:
+	ruff check .
+
+check-type:
+	mypy --strict .
+
+check-all:
+	make check-format
+	make check-lint
+	make check-type
+
+# Fix code quality issues
+fix-format:
+	ruff format .
+
+fix-lint:
+	ruff check --fix .
+
+fix-all:
+	make fix-format
+	make fix-lint
+
+# Run tests
+test:
+	pytest
+
+test-cov:
+	pytest --cov=lib --cov-report=html --cov-report=term-missing --cov-report=xml --cov-fail-under=100
+
+# Clean up generated files
+clean:
+	find . -type f -name "*.pyc" -delete
+	find . -type d -name "__pycache__" -delete
+	find . -type d -name "*.egg-info" -exec rm -rf {} +
+	rm -rf .coverage/ .pytest_cache/ .mypy_cache/
+
+# Run pre-commit hooks
+pre-commit:
+	pre-commit run --all-files

README.md

@@ -0,0 +1,25 @@
+# Python Personal Scripts
+
+Personal Python scripts and utilities.
+
+## Setup
+
+```bash
+# Install dependencies
+make install-dev
+
+# Run code quality checks
+make check-all
+
+# Fix formatting and linting issues
+make fix-all
+
+# Run tests (lib/ directory only)
+make test-cov
+```
+
+## Structure
+
+- `lib/` - Shared library modules (tested with 100% coverage)
+- `scripts/` - Executable scripts (not tested)
+- `tests/` - Test files for lib/ modules

lib/__init__.py

@@ -0,0 +1 @@
+"""Shared library modules for personal scripts."""

pyproject.toml

@@ -0,0 +1,35 @@
+# Ruff configuration
+[tool.ruff]
+line-length = 88
+target-version = "py312"
+
+[tool.ruff.lint]
+select = ["E", "W", "F", "I"]  # Basic errors, warnings, pyflakes, import sorting
+
+[tool.ruff.lint.isort]
+known-first-party = ["lib"]
+
+# mypy configuration
+[tool.mypy]
+python_version = "3.12"
+disallow_untyped_defs = true
+warn_unused_ignores = true
+
+# pytest configuration
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = ["--cov=lib", "--cov-report=html", "--cov-report=term-missing", "--cov-report=xml", "--cov-fail-under=100"]
+
+# Coverage configuration
+[tool.coverage.run]
+data_file = ".coverage/data"
+
+[tool.coverage.html]
+directory = ".coverage/htmlcov"
+
+[tool.coverage.xml]
+output = ".coverage/coverage.xml"
+
+[tool.coverage.report]
+fail_under = 100
+include = ["lib/*"]

requirements-dev.txt

@@ -0,0 +1,8 @@
+# Development dependencies
+ruff>=0.1.0
+mypy>=1.5.0
+pre-commit>=3.0.0
+
+# Testing
+pytest>=7.0.0
+pytest-cov>=4.0.0

requirements.txt

@@ -0,0 +1 @@
+# Add your project dependencies here