-
Notifications
You must be signed in to change notification settings - Fork 63
Expand file tree
/
Copy pathMakefile
More file actions
644 lines (556 loc) · 28.7 KB
/
Makefile
File metadata and controls
644 lines (556 loc) · 28.7 KB
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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
# ==============================================================================
# VARIABLES AND FUNCTIONS
# ==============================================================================
REPO_PATH := $(shell pwd)
# Package directories
CONFIG_PKG := packages/data-designer-config
ENGINE_PKG := packages/data-designer-engine
INTERFACE_PKG := packages/data-designer
# Package source and test paths
CONFIG_PATHS := $(CONFIG_PKG)/src $(CONFIG_PKG)/tests
ENGINE_PATHS := $(ENGINE_PKG)/src $(ENGINE_PKG)/tests
INTERFACE_PATHS := $(INTERFACE_PKG)/src $(INTERFACE_PKG)/tests $(INTERFACE_PKG)/dev-tools
ALL_PKG_PATHS := packages/ scripts/ tests_e2e/
# Test directories
CONFIG_TESTS := $(CONFIG_PKG)/tests
ENGINE_TESTS := $(ENGINE_PKG)/tests
INTERFACE_TESTS := $(INTERFACE_PKG)/tests
define install-pre-commit-hooks
@if [ ! -f $(REPO_PATH)/.git/hooks/pre-commit ]; then \
echo "🪝 Installing pre-commit hooks..."; \
uv run pre-commit install; \
else \
echo "👍 Pre-commit hooks already installed"; \
fi
endef
# ==============================================================================
# HELP
# ==============================================================================
help:
@echo ""
@echo "🚀 DataDesigner Makefile Commands"
@echo "═════════════════════════════════════════════════════════════"
@echo ""
@echo "📦 Installation (uv workspace - all packages in editable mode):"
@echo " install - Install all packages (config → engine → interface)"
@echo " install-dev - Install all packages + dev tools (pytest, etc.)"
@echo " install-dev-notebooks - Install all packages + dev + notebook tools"
@echo " install-dev-recipes - Install all packages + dev + recipe dependencies"
@echo ""
@echo "🧪 Testing (all packages):"
@echo " test - Run all unit tests"
@echo " coverage - Run tests with coverage report"
@echo " test-e2e - Run e2e plugin tests"
@echo " health-checks - Run provider health checks"
@echo " test-run-tutorials - Run tutorial notebooks as e2e tests"
@echo " test-run-recipes - Run recipe scripts as e2e tests"
@echo " test-run-all-examples - Run all tutorials and recipes as e2e tests"
@echo ""
@echo "🔬 Isolated Testing (mirrors CI - uses temp venv):"
@echo " test-isolated - Run all isolated tests (config → engine → interface)"
@echo " test-config-isolated - Test config with ONLY config installed"
@echo " test-engine-isolated - Test engine with ONLY engine+config installed"
@echo " test-interface-isolated - Test interface with full package installed"
@echo ""
@echo "✨ Code Quality (all packages):"
@echo " format - Format all code with ruff"
@echo " format-check - Check code formatting without making changes"
@echo " lint - Lint all code with ruff"
@echo " lint-fix - Fix linting issues automatically"
@echo " build - Build all package wheels"
@echo ""
@echo "🔍 Combined Checks:"
@echo " check-all - Run all checks (format-check + lint)"
@echo " check-all-fix - Run all checks with autofix (format + lint-fix)"
@echo ""
@echo "🛠️ Utilities:"
@echo " clean - Remove coverage reports, cache files, and dist"
@echo " clean-dist - Remove dist directories from all packages"
@echo " verify-imports - Verify all package imports work"
@echo " show-versions - Show versions of all packages"
@echo " convert-execute-notebooks - Convert notebooks from .py to .ipynb using jupytext (USE_CACHE=1 to skip unchanged)"
@echo " generate-colab-notebooks - Generate Colab-compatible notebooks"
@echo " serve-docs-locally - Serve documentation locally"
@echo " check-license-headers - Check if all files have license headers"
@echo " update-license-headers - Add license headers to all files"
@echo ""
@echo "⚡ Performance:"
@echo " perf-import - Profile pure import time and show summary"
@echo " perf-import CLEAN=1 - Clean cache, then profile pure import time"
@echo " perf-import NOFILE=1 - Profile pure import without writing to file (for CI)"
@echo " perf-import-runtime - Profile runtime init time (constructors included)"
@echo " bench-cli-startup - Benchmark CLI startup (isolated venv)"
@echo " bench-cli-startup-verbose - Benchmark CLI startup with import trace"
@echo ""
@echo "🚀 Publish:"
@echo " publish VERSION=X.Y.Z - Publish all packages to PyPI"
@echo " publish VERSION=X.Y.Z DRY_RUN=1 - Dry run (no tags or uploads)"
@echo " publish VERSION=X.Y.Z TEST_PYPI=1 - Publish to TestPyPI"
@echo " publish VERSION=X.Y.Z ALLOW_BRANCH=1 - Publish from non-main branch"
@echo " publish VERSION=X.Y.Z FORCE_TAG=1 - Overwrite existing git tag"
@echo ""
@echo "📦 Per-Package Commands (use suffix: -config, -engine, -interface):"
@echo " test-<pkg> - Run tests for a specific package"
@echo " lint-<pkg> - Lint a specific package"
@echo " lint-fix-<pkg> - Fix lint issues in a specific package"
@echo " format-<pkg> - Format a specific package"
@echo " format-check-<pkg> - Check formatting for a specific package"
@echo " check-<pkg> - Check format + lint for a specific package"
@echo " build-<pkg> - Build wheel for a specific package"
@echo " coverage-<pkg> - Run tests with coverage for a specific package"
@echo ""
@echo "═════════════════════════════════════════════════════════════"
@echo "💡 Tip: Run 'make <command>' to execute any command above"
@echo ""
# ==============================================================================
# INSTALLATION
# ==============================================================================
install:
@echo "📦 Installing DataDesigner workspace (all packages in editable mode)..."
@echo " Packages: data-designer-config → data-designer-engine → data-designer"
uv sync --all-packages
@echo "✅ Installation complete!"
@echo ""
@echo "💡 Run 'make verify-imports' to verify all packages are working"
install-dev:
@echo "📦 Installing DataDesigner workspace in development mode..."
@echo " Packages: data-designer-config → data-designer-engine → data-designer"
@echo " Groups: dev (pytest, coverage, etc.)"
uv sync --all-packages --group dev
$(call install-pre-commit-hooks)
@echo ""
@echo "✅ All packages installed in development mode!"
@echo ""
@echo "📁 Workspace structure:"
@echo " packages/data-designer-config/ - Configuration layer (lightweight)"
@echo " packages/data-designer-engine/ - Generation engine (heavy deps)"
@echo " packages/data-designer/ - Full package with CLI"
@echo ""
@echo "💡 Next steps:"
@echo " make verify-imports - Verify all packages are working"
@echo " make test - Run all tests across packages"
@echo " make test-<pkg> - Run tests for specific package (config, engine, interface)"
@echo " make lint - Lint all code"
@echo " make build - Build all package wheels"
install-dev-notebooks:
@echo "📦 Installing DataDesigner workspace with notebook dependencies..."
@echo " Packages: data-designer-config → data-designer-engine → data-designer"
@echo " Groups: dev + notebooks (Jupyter, jupytext, etc.)"
uv sync --all-packages --group dev --group notebooks
$(call install-pre-commit-hooks)
@echo "✅ Dev + notebooks installation complete!"
@echo ""
@echo "💡 Run 'make test-run-tutorials' to test notebook tutorials"
install-dev-recipes:
@echo "📦 Installing DataDesigner workspace with recipe dependencies..."
@echo " Packages: data-designer-config → data-designer-engine → data-designer"
@echo " Groups: dev + recipes (bm25s, pymupdf, etc.)"
uv sync --all-packages --group dev --group recipes
$(call install-pre-commit-hooks)
@echo "✅ Dev + recipes installation complete!"
@echo ""
@echo "💡 Run 'make test-run-recipes' to test recipe scripts"
# ==============================================================================
# TESTING
# ==============================================================================
test: test-config test-engine test-interface
@echo "✅ All package tests complete!"
test-config:
@echo "🧪 Testing data-designer-config..."
uv run --group dev pytest $(CONFIG_TESTS)
test-engine:
@echo "🧪 Testing data-designer-engine..."
uv run --group dev pytest $(ENGINE_TESTS)
test-interface:
@echo "🧪 Testing data-designer (interface)..."
uv run --group dev pytest $(INTERFACE_TESTS)
# ------------------------------------------------------------------------------
# Isolated Testing (mirrors CI behavior)
# Each package is installed independently to verify dependency boundaries
# Uses temporary virtual environments to avoid affecting the main dev environment
# ------------------------------------------------------------------------------
# Test dependencies added via --with since workspace groups aren't available with --package
TEST_DEPS := --with pytest --with pytest-asyncio --with pytest-httpx --with pytest-env
test-isolated:
@echo "🧪 Running all isolated package tests..."
@echo ""
@CONFIG_RESULT=0; ENGINE_RESULT=0; INTERFACE_RESULT=0; \
$(MAKE) test-config-isolated || CONFIG_RESULT=1; \
echo ""; \
$(MAKE) test-engine-isolated || ENGINE_RESULT=1; \
echo ""; \
$(MAKE) test-interface-isolated || INTERFACE_RESULT=1; \
echo ""; \
echo "═══════════════════════════════════════════════════════════"; \
echo "📊 Isolated Test Summary:"; \
if [ $$CONFIG_RESULT -eq 0 ]; then echo " ✅ Config tests passed"; else echo " ❌ Config tests FAILED"; fi; \
if [ $$ENGINE_RESULT -eq 0 ]; then echo " ✅ Engine tests passed"; else echo " ❌ Engine tests FAILED"; fi; \
if [ $$INTERFACE_RESULT -eq 0 ]; then echo " ✅ Interface tests passed"; else echo " ❌ Interface tests FAILED"; fi; \
echo "═══════════════════════════════════════════════════════════"; \
if [ $$CONFIG_RESULT -ne 0 ] || [ $$ENGINE_RESULT -ne 0 ] || [ $$INTERFACE_RESULT -ne 0 ]; then \
echo "❌ Some isolated tests FAILED!"; \
exit 1; \
fi; \
echo "✅ All isolated package tests passed!"
test-config-isolated:
@echo "🧪 Testing data-designer-config in isolation..."
@ISOLATED_VENV=$$(mktemp -d); \
trap "rm -rf $$ISOLATED_VENV" EXIT; \
echo " Creating isolated environment in $$ISOLATED_VENV..."; \
echo " Installing config package only (no engine/interface)..."; \
UV_PROJECT_ENVIRONMENT="$$ISOLATED_VENV" uv sync --package data-designer-config && \
UV_PROJECT_ENVIRONMENT="$$ISOLATED_VENV" uv run $(TEST_DEPS) pytest -v $(CONFIG_TESTS) && \
echo "✅ Config tests passed in isolation!" || \
{ echo "❌ Config tests FAILED in isolation!"; exit 1; }
test-engine-isolated:
@echo "🧪 Testing data-designer-engine in isolation..."
@ISOLATED_VENV=$$(mktemp -d); \
trap "rm -rf $$ISOLATED_VENV" EXIT; \
echo " Creating isolated environment in $$ISOLATED_VENV..."; \
echo " Installing engine package only (auto-includes config)..."; \
UV_PROJECT_ENVIRONMENT="$$ISOLATED_VENV" uv sync --package data-designer-engine && \
UV_PROJECT_ENVIRONMENT="$$ISOLATED_VENV" uv run $(TEST_DEPS) pytest -v $(ENGINE_TESTS) && \
echo "✅ Engine tests passed in isolation!" || \
{ echo "❌ Engine tests FAILED in isolation!"; exit 1; }
test-interface-isolated:
@echo "🧪 Testing data-designer (interface) in isolation..."
@ISOLATED_VENV=$$(mktemp -d); \
trap "rm -rf $$ISOLATED_VENV" EXIT; \
echo " Creating isolated environment in $$ISOLATED_VENV..."; \
echo " Installing interface package (auto-includes config + engine)..."; \
UV_PROJECT_ENVIRONMENT="$$ISOLATED_VENV" uv sync --package data-designer && \
UV_PROJECT_ENVIRONMENT="$$ISOLATED_VENV" uv run $(TEST_DEPS) pytest -v $(INTERFACE_TESTS) && \
echo "✅ Interface tests passed in isolation!" || \
{ echo "❌ Interface tests FAILED in isolation!"; exit 1; }
# Note: coverage runs all tests in a single pytest invocation for combined coverage reporting.
# This is intentionally different from calling coverage-config/engine/interface individually.
coverage:
@echo "📊 Running tests with coverage analysis (all packages)..."
uv run --group dev pytest \
$(CONFIG_TESTS) \
$(ENGINE_TESTS) \
$(INTERFACE_TESTS) \
--cov=data_designer \
--cov-report=term-missing \
--cov-report=html
@echo "✅ Coverage report generated in htmlcov/index.html"
coverage-config:
@echo "📊 Running config tests with coverage..."
uv run --group dev pytest $(CONFIG_TESTS) --cov=data_designer --cov-report=term-missing --cov-report=html
coverage-engine:
@echo "📊 Running engine tests with coverage..."
uv run --group dev pytest $(ENGINE_TESTS) --cov=data_designer --cov-report=term-missing --cov-report=html
coverage-interface:
@echo "📊 Running interface tests with coverage..."
uv run --group dev pytest $(INTERFACE_TESTS) --cov=data_designer --cov-report=term-missing --cov-report=html
test-e2e:
@echo "🧹 Cleaning e2e test environment..."
rm -rf tests_e2e/uv.lock tests_e2e/__pycache__ tests_e2e/.venv
@echo "🧪 Running e2e tests..."
uv run --no-cache --refresh --directory tests_e2e pytest -s
health-checks:
@echo "🏥 Running provider health checks..."
uv run --group dev python scripts/health_checks.py
test-run-tutorials:
@echo "🧪 Running tutorials as e2e tests..."
@TUTORIAL_WORKDIR=$$(mktemp -d); \
trap "rm -rf $$TUTORIAL_WORKDIR" EXIT; \
for f in docs/notebook_source/*.py; do \
echo " 📓 Running $$f..."; \
(cd "$$TUTORIAL_WORKDIR" && uv run --project "$(REPO_PATH)" --group notebooks python "$(REPO_PATH)/$$f") || exit 1; \
done; \
echo "🧹 Cleaning up tutorial artifacts..."; \
rm -rf "$$TUTORIAL_WORKDIR"; \
echo "✅ All tutorials completed successfully!"
test-run-recipes:
@echo "🧪 Running recipes as e2e tests..."
@RECIPE_WORKDIR=$$(mktemp -d); \
trap "rm -rf $$RECIPE_WORKDIR" EXIT; \
for f in docs/assets/recipes/**/*.py; do \
echo " 📜 Running $$f..."; \
(cd "$$RECIPE_WORKDIR" && uv run --project "$(REPO_PATH)" --group notebooks --group recipes python "$(REPO_PATH)/$$f" --model-alias nvidia-text --artifact-path "$$RECIPE_WORKDIR" --num-records 5) || exit 1; \
done; \
echo "🧹 Cleaning up recipe artifacts..."; \
rm -rf "$$RECIPE_WORKDIR"; \
echo "✅ All recipes completed successfully!"
test-run-all-examples: test-run-tutorials test-run-recipes
@echo "✅ All examples (tutorials + recipes) completed successfully!"
# ==============================================================================
# CODE QUALITY - FORMATTING
# ==============================================================================
format: format-config format-engine format-interface
@echo "📐 Formatting scripts and tests_e2e..."
uv run ruff format scripts/ tests_e2e/
@echo "✅ Formatting complete!"
format-check: format-check-config format-check-engine format-check-interface
@echo "📐 Checking scripts and tests_e2e formatting..."
uv run ruff format --check scripts/ tests_e2e/
@echo "✅ Formatting check complete! Run 'make format' to auto-fix issues."
format-config:
@echo "📐 Formatting data-designer-config..."
uv run ruff format $(CONFIG_PATHS) --exclude '**/_version.py'
format-engine:
@echo "📐 Formatting data-designer-engine..."
uv run ruff format $(ENGINE_PATHS) --exclude '**/_version.py'
format-interface:
@echo "📐 Formatting data-designer (interface)..."
uv run ruff format $(INTERFACE_PATHS) --exclude '**/_version.py'
format-check-config:
@echo "📐 Checking data-designer-config formatting..."
uv run ruff format --check $(CONFIG_PATHS) --exclude '**/_version.py'
format-check-engine:
@echo "📐 Checking data-designer-engine formatting..."
uv run ruff format --check $(ENGINE_PATHS) --exclude '**/_version.py'
format-check-interface:
@echo "📐 Checking data-designer (interface) formatting..."
uv run ruff format --check $(INTERFACE_PATHS) --exclude '**/_version.py'
# ==============================================================================
# CODE QUALITY - LINTING
# ==============================================================================
lint: lint-config lint-engine lint-interface
@echo "🔍 Linting scripts and tests_e2e..."
uv run ruff check --output-format=full scripts/ tests_e2e/
@echo "✅ Linting complete! Run 'make lint-fix' to auto-fix issues."
lint-fix: lint-fix-config lint-fix-engine lint-fix-interface
@echo "🔍 Fixing lint issues in scripts and tests_e2e..."
uv run ruff check --fix scripts/ tests_e2e/
@echo "✅ Linting with autofix complete!"
lint-config:
@echo "🔍 Linting data-designer-config..."
uv run ruff check --output-format=full $(CONFIG_PATHS) --exclude '**/_version.py'
lint-engine:
@echo "🔍 Linting data-designer-engine..."
uv run ruff check --output-format=full $(ENGINE_PATHS) --exclude '**/_version.py'
lint-interface:
@echo "🔍 Linting data-designer (interface)..."
uv run ruff check --output-format=full $(INTERFACE_PATHS) --exclude '**/_version.py'
lint-fix-config:
@echo "🔍 Fixing lint issues in data-designer-config..."
uv run ruff check --fix $(CONFIG_PATHS) --exclude '**/_version.py'
lint-fix-engine:
@echo "🔍 Fixing lint issues in data-designer-engine..."
uv run ruff check --fix $(ENGINE_PATHS) --exclude '**/_version.py'
lint-fix-interface:
@echo "🔍 Fixing lint issues in data-designer (interface)..."
uv run ruff check --fix $(INTERFACE_PATHS) --exclude '**/_version.py'
# ==============================================================================
# CODE QUALITY - COMBINED CHECKS
# ==============================================================================
check-all: format-check lint
@echo "✅ All checks complete!"
check-all-fix: format lint-fix
@echo "✅ All checks with autofix complete!"
check-config: format-check-config lint-config
@echo "✅ Checks complete for data-designer-config!"
check-engine: format-check-engine lint-engine
@echo "✅ Checks complete for data-designer-engine!"
check-interface: format-check-interface lint-interface
@echo "✅ Checks complete for data-designer (interface)!"
# ==============================================================================
# BUILD
# ==============================================================================
build: build-config build-engine build-interface
@echo "✅ All packages built!"
build-config:
@echo "🏗️ Building data-designer-config..."
cd $(CONFIG_PKG) && uv build -o dist
build-engine:
@echo "🏗️ Building data-designer-engine..."
cd $(ENGINE_PKG) && uv build -o dist
build-interface:
@echo "🏗️ Building data-designer (interface)..."
cd $(INTERFACE_PKG) && uv build -o dist
# ==============================================================================
# UTILITIES
# ==============================================================================
verify-imports:
@echo "🔍 Verifying package imports..."
uv run python -c "from data_designer.config.config_builder import DataDesignerConfigBuilder; print(' ✓ config')"
uv run python -c "from data_designer.engine.compiler import compile_data_designer_config; print(' ✓ engine')"
uv run python -c "from data_designer.interface.data_designer import DataDesigner; print(' ✓ interface')"
@echo "✅ All imports verified!"
show-versions:
@echo "📦 Package versions:"
@uv run python -c "from data_designer.config._version import __version__; print(f' data-designer-config: {__version__}')" 2>/dev/null || echo " data-designer-config: (not installed)"
@uv run python -c "from data_designer.engine._version import __version__; print(f' data-designer-engine: {__version__}')" 2>/dev/null || echo " data-designer-engine: (not installed)"
@uv run python -c "from data_designer.interface._version import __version__; print(f' data-designer: {__version__}')" 2>/dev/null || echo " data-designer: (not installed)"
# ==============================================================================
# LICENSE HEADERS
# ==============================================================================
check-license-headers:
@echo "🔍 Checking license headers in all files..."
uv run python $(REPO_PATH)/scripts/update_license_headers.py --check
update-license-headers:
@echo "🔍 Updating license headers in all files..."
uv run python $(REPO_PATH)/scripts/update_license_headers.py
# ==============================================================================
# DOCUMENTATION
# ==============================================================================
serve-docs-locally:
@echo "📝 Building and serving docs..."
uv sync --group docs
uv run mkdocs serve --livereload
convert-execute-notebooks:
ifeq ($(USE_CACHE),1)
@echo "📓 Converting Python tutorials to notebooks (with caching)..."
@bash docs/scripts/build_notebooks_cached.sh
else
@echo "📓 Converting Python tutorials to notebooks and executing..."
@mkdir -p docs/notebooks
cp docs/notebook_source/_README.md docs/notebooks/README.md
cp docs/notebook_source/_pyproject.toml docs/notebooks/pyproject.toml
uv run --all-packages --group notebooks --group docs jupytext --to ipynb --execute docs/notebook_source/*.py
mv docs/notebook_source/*.ipynb docs/notebooks/
rm -r docs/notebook_source/artifacts
rm docs/notebook_source/*.csv
@echo "✅ Notebooks created in docs/notebooks/"
endif
generate-colab-notebooks:
@echo "📓 Generating Colab-compatible notebooks..."
uv run --group docs python docs/scripts/generate_colab_notebooks.py
@echo "✅ Colab notebooks created in docs/colab_notebooks/"
# ==============================================================================
# PERFORMANCE
# ==============================================================================
perf-import:
ifdef CLEAN
@$(MAKE) clean-pycache
endif
@echo "⚡ Profiling pure import time for data_designer.config and DataDesigner symbol..."
ifdef NOFILE
@PERF_OUTPUT=$$(uv run python -X importtime -c "import data_designer.config as dd; from data_designer.interface import DataDesigner" 2>&1); \
echo "$$PERF_OUTPUT"; \
echo ""; \
echo "Summary:"; \
echo "$$PERF_OUTPUT" | tail -1 | awk '{printf " Total: %.3fs\n", $$5/1000000}'; \
echo ""; \
echo "💡 Top 10 slowest imports:"; \
printf "%-12s %-12s %s\n" "Self (s)" "Cumulative (s)" "Module"; \
printf "%-12s %-12s %s\n" "--------" "--------------" "------"; \
echo "$$PERF_OUTPUT" | grep "import time:" | sort -rn -k5 | head -10 | awk '{printf "%-12.3f %-12.3f %s", $$3/1000000, $$5/1000000, $$7; for(i=8;i<=NF;i++) printf " %s", $$i; printf "\n"}'
else
@PERF_FILE="perf_import_$$(date +%Y%m%d_%H%M%S).txt"; \
uv run python -X importtime -c "import data_designer.config as dd; from data_designer.interface import DataDesigner" > "$$PERF_FILE" 2>&1; \
echo "📊 Import profile saved to $$PERF_FILE"; \
echo ""; \
echo "Summary:"; \
tail -1 "$$PERF_FILE" | awk '{printf " Total: %.3fs\n", $$5/1000000}'; \
echo ""; \
echo "💡 Top 10 slowest imports:"; \
printf "%-12s %-12s %s\n" "Self (s)" "Cumulative (s)" "Module"; \
printf "%-12s %-12s %s\n" "--------" "--------------" "------"; \
grep "import time:" "$$PERF_FILE" | sort -rn -k5 | head -10 | awk '{printf "%-12.3f %-12.3f %s", $$3/1000000, $$5/1000000, $$7; for(i=8;i<=NF;i++) printf " %s", $$i; printf "\n"}'
endif
perf-import-runtime:
ifdef CLEAN
@$(MAKE) clean-pycache
endif
@echo "⚡ Profiling runtime initialization time (DataDesigner + DataDesignerConfigBuilder constructors)..."
ifdef NOFILE
@PERF_OUTPUT=$$(uv run python -X importtime -c "import data_designer.config as dd; from data_designer.interface import DataDesigner; DataDesigner(); dd.DataDesignerConfigBuilder()" 2>&1); \
echo "$$PERF_OUTPUT"; \
echo ""; \
echo "Summary:"; \
echo "$$PERF_OUTPUT" | tail -1 | awk '{printf " Total: %.3fs\n", $$5/1000000}'; \
echo ""; \
echo "💡 Top 10 slowest imports:"; \
printf "%-12s %-12s %s\n" "Self (s)" "Cumulative (s)" "Module"; \
printf "%-12s %-12s %s\n" "--------" "--------------" "------"; \
echo "$$PERF_OUTPUT" | grep "import time:" | sort -rn -k5 | head -10 | awk '{printf "%-12.3f %-12.3f %s", $$3/1000000, $$5/1000000, $$7; for(i=8;i<=NF;i++) printf " %s", $$i; printf "\n"}'
else
@PERF_FILE="perf_import_runtime_$$(date +%Y%m%d_%H%M%S).txt"; \
uv run python -X importtime -c "import data_designer.config as dd; from data_designer.interface import DataDesigner; DataDesigner(); dd.DataDesignerConfigBuilder()" > "$$PERF_FILE" 2>&1; \
echo "📊 Runtime import profile saved to $$PERF_FILE"; \
echo ""; \
echo "Summary:"; \
tail -1 "$$PERF_FILE" | awk '{printf " Total: %.3fs\n", $$5/1000000}'; \
echo ""; \
echo "💡 Top 10 slowest imports:"; \
printf "%-12s %-12s %s\n" "Self (s)" "Cumulative (s)" "Module"; \
printf "%-12s %-12s %s\n" "--------" "--------------" "------"; \
grep "import time:" "$$PERF_FILE" | sort -rn -k5 | head -10 | awk '{printf "%-12.3f %-12.3f %s", $$3/1000000, $$5/1000000, $$7; for(i=8;i<=NF;i++) printf " %s", $$i; printf "\n"}'
endif
BENCH_CLI_ARGS ?=
bench-cli-startup:
@echo "⚡ Benchmarking CLI startup time (isolated venv)..."
uv run python scripts/benchmarks/benchmark_cli_startup.py $(BENCH_CLI_ARGS)
bench-cli-startup-verbose:
@echo "⚡ Benchmarking CLI startup time (isolated + import trace)..."
uv run python scripts/benchmarks/benchmark_cli_startup.py --verbose $(BENCH_CLI_ARGS)
# ==============================================================================
# PUBLISH
# ==============================================================================
# Build publish flags based on options
PUBLISH_FLAGS :=
ifdef DRY_RUN
PUBLISH_FLAGS += --dry-run
endif
ifdef TEST_PYPI
PUBLISH_FLAGS += --test-pypi
endif
ifdef ALLOW_BRANCH
PUBLISH_FLAGS += --allow-branch
endif
ifdef FORCE_TAG
PUBLISH_FLAGS += --force-tag
endif
publish:
ifndef VERSION
$(error VERSION is required. Usage: make publish VERSION=0.3.9rc1 [DRY_RUN=1] [TEST_PYPI=1] [ALLOW_BRANCH=1] [FORCE_TAG=1])
endif
ifdef TEST_PYPI
@echo "🚀 Publishing version $(VERSION) to TestPyPI..."
else
ifdef DRY_RUN
@echo "🚀 Running publish dry-run for version $(VERSION)..."
else
@echo "🚀 Publishing version $(VERSION) to PyPI..."
endif
endif
$(REPO_PATH)/scripts/publish.sh $(VERSION) $(PUBLISH_FLAGS)
# ==============================================================================
# CLEANUP
# ==============================================================================
clean: clean-pycache clean-dist clean-notebooks clean-test-coverage
@echo "✅ Cleaned!"
clean-pycache:
@echo "🧹 Cleaning up Python cache files..."
find . -type d -name __pycache__ -exec rm -rf {} + 2>/dev/null || true
find . -type f -name "*.pyc" -delete 2>/dev/null || true
@echo "✅ Cache cleaned!"
clean-dist:
@echo "🧹 Cleaning dist directories..."
rm -rf $(CONFIG_PKG)/dist
rm -rf $(ENGINE_PKG)/dist
rm -rf $(INTERFACE_PKG)/dist
rm -f packages/*/src/data_designer/*/_version.py
@echo "✅ Dist directories cleaned!"
clean-notebooks:
@echo "🧹 Cleaning up notebooks..."
rm -rf docs/notebooks
@echo "✅ Notebooks cleaned!"
clean-test-coverage:
@echo "🧹 Cleaning up test coverage..."
rm -rf htmlcov .coverage .pytest_cache
@echo "✅ Test coverage cleaned!"
# ==============================================================================
# PHONY TARGETS
# ==============================================================================
.PHONY: bench-cli-startup bench-cli-startup-verbose \
build build-config build-engine build-interface \
check-all check-all-fix check-config check-engine check-interface \
check-license-headers \
clean clean-dist clean-notebooks clean-pycache clean-test-coverage \
convert-execute-notebooks \
coverage coverage-config coverage-engine coverage-interface \
format format-check format-check-config format-check-engine format-check-interface \
format-config format-engine format-interface \
generate-colab-notebooks help \
install install-dev install-dev-notebooks install-dev-recipes \
lint lint-config lint-engine lint-fix lint-fix-config lint-fix-engine lint-fix-interface lint-interface \
perf-import perf-import-runtime publish serve-docs-locally show-versions \
health-checks \
test test-config test-config-isolated test-e2e test-engine test-engine-isolated \
test-interface test-interface-isolated test-isolated \
test-run-all-examples test-run-recipes test-run-tutorials \
update-license-headers verify-imports