python-starter-template/Makefile at main · JoshCLWren/python-starter-template · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
.PHONY: help init lint pytest sync venv run githook install-githook

# Configuration
PREFIX ?= /usr/local
BINDIR ?= $(PREFIX)/bin
LIBDIR ?= $(PREFIX)/lib

help:  ## Show this help message
	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'

init:  ## Initialize project with new name (Usage: make init NAME=your-project)
	@if [ -z "$(NAME)" ]; then echo "Usage: make init NAME=your-project"; exit 1; fi
	$(eval PKG_DIR := $(subst -,_,$(NAME)))
	@echo "Initializing project as $(NAME) (package dir: $(PKG_DIR))..."
	@sed -i.bak 's/name = "python-starter-template"/name = "$(NAME)"/' pyproject.toml && rm pyproject.toml.bak
	@sed -i.bak 's/example_module/$(PKG_DIR)/g' pyproject.toml && rm pyproject.toml.bak
	@sed -i.bak 's/example_module/$(PKG_DIR)/g' .github/workflows/ci.yml && rm .github/workflows/ci.yml.bak
	@if [ -d "example_module" ]; then \
		echo "Renaming example_module to $(PKG_DIR)..."; \
		mv example_module $(PKG_DIR); \
		find . -type f -name "*.py" -not -path "./.venv/*" -exec sed -i.bak "s/from example_module/from $(PKG_DIR)/g" {} +; \
		find . -type f -name "*.py" -not -path "./.venv/*" -exec sed -i.bak "s/import example_module/import $(PKG_DIR)/g" {} +; \
		find . -type f -name "*.py.bak" -delete; \
	fi
	@if [ -f "main.py" ]; then \
		echo "Removing template main.py (library package)..."; \
		rm main.py; \
	fi
	@echo ""
	@echo "✅ Project initialized successfully!"
	@echo ""
	@echo "📋 SUMMARY OF CHANGES:"
	@echo "  • Module renamed to: $(PKG_DIR)"
	@echo "  • Package name in pyproject.toml: $(NAME)"
	@echo "  • Python imports updated to use: $(PKG_DIR)"
	@echo "  • CI workflow updated"
	@echo "  • Template main.py removed (library package structure)"
	@echo ""
	@echo "⚠️  MANUAL UPDATES REQUIRED:"
	@echo "  • Replace [[MODULE_NAME]] with $(PKG_DIR) in README.md and AGENTS.md"
	@echo "  • Update CI badge URLs in README.md (YOUR_USERNAME/YOUR_REPO)"
	@echo "  • Update project title, description, and features in README.md"
	@echo "  • Review and customize AGENTS.md for your project"
	@echo "  • See POST_INIT_CHECKLIST.md for complete details"
	@echo ""
	@echo "📦 NEXT STEPS:"
	@echo "  1. Run: uv sync --all-extras"
	@echo "  2. Run: source .venv/bin/activate"
	@echo "  3. Run: make lint && make pytest"
	@echo "  4. Follow POST_INIT_CHECKLIST.md for customization"
	@echo ""

lint:  ## Run code linting
	bash scripts/lint.sh

install-githook:  ## Install pre-commit hook for new developers
	@mkdir -p .git/hooks
	@cp .githooks/pre-commit .git/hooks/pre-commit
	@chmod +x .git/hooks/pre-commit
	@echo "Pre-commit hook installed to .git/hooks/pre-commit"

githook: install-githook  ## Run lint checks manually (installs pre-commit hook if missing)
	bash scripts/lint.sh

pytest:  ## Run tests
	pytest

sync:  ## Install dependencies
	uv sync --group dev

venv:  ## Create virtual environment
	uv venv

run:  ## Run the app
	python main.py