qubex/Makefile at develop · msk-ono/qubex · 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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
.PHONY: upgrade sync test coverage check fix lint lint-fix format format-check type-check clean build build-all publish-all docs docs-serve docs-build docs-clean sync-release-version check-release-version

BUILD_CMD := uv run --with build python -m build
TWINE_CMD := uv run --with twine twine
REPOSITORY ?= testpypi
PUBLISH_TARGETS := \
	qxcore:packages/qxcore \
	qxvisualizer:packages/qxvisualizer \
	qxfitting:packages/qxfitting \
	qxpulse:packages/qxpulse \
	qxschema:packages/qxschema \
	qxsimulator:packages/qxsimulator \
	qxdriver-quel1:packages/qxdriver-quel1 \
	qubex:.

# Upgrade locked dependencies and sync the backend development environment
upgrade:
	git submodule update --init --recursive --remote
	uv sync --all-groups --all-extras --upgrade

# Install the locked backend development environment
sync:
	git submodule update --init --recursive
	uv sync --all-groups --all-extras --locked

# Run unit tests
test:
	uv run pytest

# Run tests with coverage
coverage:
	uv run pytest --cov=qubex --cov-report=term-missing

# Run type, lint, and format checks
check: check-release-version type-check lint format-check

# Auto-fix formatting and lint issues
fix: format lint-fix

# Lint the codebase
lint:
	uv run ruff check

# Auto-fix lint issues
lint-fix:
	uv run ruff check --fix

# Format the codebase
format:
	uv run ruff format

# Check formatting without modifying files
format-check:
	uv run ruff format --check

# Run static type checking
type-check:
	uv run pyright

# Synchronize workspace package versions from VERSION
sync-release-version:
	uv run python scripts/sync_release_version.py $(if $(VERSION),--version $(VERSION),)

# Check workspace package versions against VERSION
check-release-version:
	uv run python scripts/check_release_version.py

# Remove caches and build artifacts
clean:
	rm -rf .cache .coverage .pytest_cache .ruff_cache .venv dist site
	find . -type d -name "__pycache__" -exec rm -rf {} +
	find . -type d -name "*.egg-info" -exec rm -rf {} +

# Build distribution artifacts
build:
	$(BUILD_CMD)

# Build all publishable packages in dependency order
build-all: check-release-version
	rm -rf dist/publish
	mkdir -p dist/publish
	@set -e; \
	for spec in $(PUBLISH_TARGETS); do \
		name=$${spec%%:*}; \
		path=$${spec#*:}; \
		outdir=dist/publish/$$name; \
		mkdir -p "$$outdir"; \
		$(BUILD_CMD) --outdir "$$outdir" "$$path"; \
	done

# Publish all package artifacts to the selected repository in dependency order
publish-all: build-all
	@set -e; \
	for spec in $(PUBLISH_TARGETS); do \
		name=$${spec%%:*}; \
		$(TWINE_CMD) upload --repository $(REPOSITORY) --skip-existing dist/publish/$$name/*; \
	done

# Build documentation site
docs: docs-build

# Serve documentation locally
docs-serve:
	uv run mkdocs serve --livereload --dirty

# Build documentation into the site/ directory
docs-build:
	uv run mkdocs build

# Remove generated documentation output
docs-clean:
	rm -rf site