decree-python/Makefile at main · opendecree/decree-python · 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
TOOLS_IMAGE := decree-python-tools
TOOLS_SENTINEL := .tools-image-built
DOCKER_RUN      := docker run --rm -u $(shell id -u):$(shell id -g) -e HOME=/tmp -v $(CURDIR):/workspace -v $(CURDIR)/../decree/proto:/proto:ro -w /workspace $(TOOLS_IMAGE)
DOCKER_RUN_ROOT := docker run --rm -v $(CURDIR):/workspace -v $(CURDIR)/../decree/proto:/proto:ro -w /workspace $(TOOLS_IMAGE)

PROTO_DIR := /proto
GEN_DIR   := sdk/src/opendecree/_generated

.PHONY: all generate lint format typecheck test build clean tools docs pre-commit help

all: generate lint typecheck test

## pre-commit: Run local checks before committing (skip codegen)
pre-commit: lint typecheck test

## tools: Build the tools Docker image (only when Dockerfile.tools changes)
tools: $(TOOLS_SENTINEL)
$(TOOLS_SENTINEL): build/Dockerfile.tools
	docker build -t $(TOOLS_IMAGE) -f build/Dockerfile.tools build/
	@touch $(TOOLS_SENTINEL)

## generate: Generate Python proto stubs from proto definitions
generate: $(TOOLS_SENTINEL)
	$(DOCKER_RUN) sh -c '\
		SITE=$$(python -c "import site; print(site.getsitepackages()[0])") && \
		GRPC_PROTO=$$(python -c "import grpc_tools; import os; print(os.path.join(os.path.dirname(grpc_tools.__file__), \"_proto\"))") && \
		python -m grpc_tools.protoc \
			-I $(PROTO_DIR) \
			-I $$GRPC_PROTO \
			-I $$SITE \
			--python_out=$(GEN_DIR) \
			--grpc_python_out=$(GEN_DIR) \
			--mypy_out=$(GEN_DIR) \
			--mypy_grpc_out=$(GEN_DIR) \
			$(PROTO_DIR)/centralconfig/v1/*.proto'
	@echo "Generated stubs in $(GEN_DIR)"

## lint: Lint with ruff (check + format)
lint: $(TOOLS_SENTINEL)
	$(DOCKER_RUN) ruff check sdk/src/ sdk/tests/
	$(DOCKER_RUN) ruff format --check sdk/src/ sdk/tests/

## format: Auto-format with ruff
format: $(TOOLS_SENTINEL)
	$(DOCKER_RUN) ruff format sdk/src/ sdk/tests/
	$(DOCKER_RUN) ruff check --fix sdk/src/ sdk/tests/

## typecheck: Type check with mypy
typecheck: $(TOOLS_SENTINEL)
	$(DOCKER_RUN) sh -c "cd sdk && mypy src/"

## test: Run tests with coverage
test: $(TOOLS_SENTINEL)
	$(DOCKER_RUN_ROOT) sh -c "cd sdk && pip install -e . -q 2>/dev/null && pytest --cov --cov-report=term-missing"

## docs: Generate API reference HTML from docstrings (pdoc)
docs: $(TOOLS_SENTINEL)
	@mkdir -p sdk/docs/api
	$(DOCKER_RUN_ROOT) sh -c "cd sdk && pip install -e . -q 2>/dev/null && pdoc --output-directory /workspace/sdk/docs/api --no-show-source --docformat google opendecree !opendecree._generated && chown -R $(shell id -u):$(shell id -g) /workspace/sdk/docs/api"
	@echo "Generated API docs in sdk/docs/api/"

## build: Build sdist + wheel
build: $(TOOLS_SENTINEL)
	$(DOCKER_RUN) sh -c "cd sdk && python -m build"

## clean: Remove build artifacts
clean: $(TOOLS_SENTINEL)
	$(DOCKER_RUN_ROOT) rm -rf sdk/dist/ sdk/build/ sdk/src/*.egg-info
	$(DOCKER_RUN_ROOT) find . -type d -name __pycache__ -exec rm -rf {} + 2>/dev/null || true

## help: Show this help
help:
	@grep -E '^## ' $(MAKEFILE_LIST) | sed 's/## //' | column -t -s ':'