-
Notifications
You must be signed in to change notification settings - Fork 113
Expand file tree
/
Copy pathmakefile
More file actions
314 lines (295 loc) Β· 11.8 KB
/
makefile
File metadata and controls
314 lines (295 loc) Β· 11.8 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
.PHONY: help bootstrap install format format-check lint lint-fix check type-check clean build \
build-rtc build-wheel generate-proto download-ffi status doctor
# Colors for output
CYAN := \033[36m
GREEN := \033[32m
YELLOW := \033[33m
RED := \033[31m
RESET := \033[0m
BOLD := \033[1m
# Paths (computed as absolute paths)
MAKEFILE_DIR := $(shell pwd)
PYTHON_RTC := $(MAKEFILE_DIR)/livekit-rtc
PYTHON_API := $(MAKEFILE_DIR)/livekit-api
PYTHON_PROTOCOL := $(MAKEFILE_DIR)/livekit-protocol
RUST_SUBMODULE := $(MAKEFILE_DIR)/livekit-rtc/rust-sdks
# Platform and architecture auto-detection
ARCH := $(shell uname -m)
OS := $(shell uname -s | tr A-Z a-z)
# Default target
.DEFAULT_GOAL := help
help: ## Show this help message
@echo "$(BOLD)$(CYAN)Available targets:$(RESET)"
@echo ""
@echo "$(BOLD)Development Workflows:$(RESET)"
@grep -E '^(bootstrap|build-rtc|build-wheel|download-ffi|status|doctor):.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf " $(CYAN)%-20s$(RESET) %s\n", $$1, $$2}'
@echo ""
@echo "$(BOLD)Code Quality:$(RESET)"
@grep -E '^(format|format-check|lint|lint-fix|type-check|check):.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf " $(CYAN)%-20s$(RESET) %s\n", $$1, $$2}'
@echo ""
@echo "$(BOLD)Other:$(RESET)"
@grep -E '^(install|clean|build):.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf " $(CYAN)%-20s$(RESET) %s\n", $$1, $$2}'
install: ## Install all dependencies with dev extras
@echo "$(BOLD)$(CYAN)Installing dependencies...$(RESET)"
@uv sync --all-extras --dev
@echo "$(BOLD)$(GREEN)β Dependencies installed$(RESET)"
format: ## Format code with ruff
@echo "$(BOLD)$(CYAN)Formatting code...$(RESET)"
@uv run ruff format .
@echo "$(BOLD)$(GREEN)β Code formatted$(RESET)"
format-check: ## Check code formatting without making changes
@echo "$(BOLD)$(CYAN)Checking code formatting...$(RESET)"
@if uv run ruff format --check .; then \
echo "$(BOLD)$(GREEN)β Code formatting is correct$(RESET)"; \
else \
echo "$(BOLD)$(RED)β Code formatting issues found. Run 'make format' to fix.$(RESET)"; \
exit 1; \
fi
lint: ## Run ruff linter
@echo "$(BOLD)$(CYAN)Running linter...$(RESET)"
@if uv run ruff check .; then \
echo "$(BOLD)$(GREEN)β No linting issues found$(RESET)"; \
else \
echo "$(BOLD)$(RED)β Linting issues found$(RESET)"; \
exit 1; \
fi
lint-fix: ## Run ruff linter and fix issues automatically
@echo "$(BOLD)$(CYAN)Running linter with auto-fix...$(RESET)"
@uv run ruff check --fix .
@echo "$(BOLD)$(GREEN)β Linting complete$(RESET)"
type-check: ## Run mypy type checker
@echo "$(BOLD)$(CYAN)Running type checker...$(RESET)"
@uv pip install pip 2>/dev/null || true
@if uv run mypy --install-types --non-interactive \
-p livekit.rtc \
-p livekit.api \
-p livekit.protocol; then \
echo "$(BOLD)$(GREEN)β Type checking passed$(RESET)"; \
else \
echo "$(BOLD)$(RED)β Type checking failed$(RESET)"; \
exit 1; \
fi
check: format-check lint type-check ## Run all checks (format, lint, type-check)
@echo "$(BOLD)$(GREEN)β All checks passed!$(RESET)"
# ============================================
# Development Workflows
# ============================================
download-ffi: ## Download pre-built FFI artifacts for livekit-rtc
@echo "$(BOLD)$(CYAN)π¦ Downloading FFI artifacts...$(RESET)"
@set -e; \
DETECTED_ARCH="$(ARCH)"; \
DETECTED_OS="$(OS)"; \
if [ "$$DETECTED_ARCH" = "aarch64" ]; then \
PLATFORM_ARCH="arm64"; \
else \
PLATFORM_ARCH="$$DETECTED_ARCH"; \
fi; \
if [ "$$DETECTED_OS" = "darwin" ]; then \
PLATFORM_OS="macos"; \
else \
PLATFORM_OS="$$DETECTED_OS"; \
fi; \
echo "$(CYAN) Platform: $$PLATFORM_OS-$$PLATFORM_ARCH$(RESET)"; \
cd $(PYTHON_RTC) && python rust-sdks/download_ffi.py --platform "$$PLATFORM_OS" --arch "$$PLATFORM_ARCH" --output livekit/rtc/resources; \
echo "$(BOLD)$(GREEN)β
FFI artifacts downloaded$(RESET)"
build-rtc: ## Build livekit-ffi from local rust-sdks and generate proto
@echo "$(BOLD)$(CYAN)π¦ Building livekit-ffi from source...$(RESET)"
@set -e; \
if [ ! -d "$(RUST_SUBMODULE)" ]; then \
echo "$(BOLD)$(RED)β Error: rust-sdks submodule not found at $(RUST_SUBMODULE)$(RESET)"; \
exit 1; \
fi; \
echo "$(CYAN)π¦ Building livekit-ffi...$(RESET)"; \
cd $(RUST_SUBMODULE) && cargo build --release -p livekit-ffi; \
echo "$(CYAN)π Generating protobuf FFI protocol...$(RESET)"; \
cd $(PYTHON_RTC) && ./generate_proto.sh; \
RUST_LIB_DIR="$$(cd $(RUST_SUBMODULE) && pwd)/target/release"; \
if [ "$(OS)" = "darwin" ]; then \
RUST_LIB_PATH="$$RUST_LIB_DIR/liblivekit_ffi.dylib"; \
elif [ "$(OS)" = "linux" ]; then \
RUST_LIB_PATH="$$RUST_LIB_DIR/liblivekit_ffi.so"; \
else \
RUST_LIB_PATH="$$RUST_LIB_DIR/livekit_ffi.dll"; \
fi; \
echo "$(BOLD)$(GREEN)β
Built livekit-ffi from source$(RESET)"; \
echo ""; \
echo "$(BOLD)$(YELLOW)π To use the local rust lib, export the following:$(RESET)"; \
echo "$(BOLD) export LIVEKIT_LIB_PATH=$$RUST_LIB_PATH$(RESET)"
build-wheel: ## Build wheel for a package (usage: make build-wheel PACKAGE=livekit-rtc)
@echo "$(BOLD)$(CYAN)π¦ Building wheel...$(RESET)"
@set -e; \
if [ -z "$(PACKAGE)" ]; then \
echo "$(BOLD)$(RED)β Error: PACKAGE parameter is required$(RESET)"; \
echo "$(YELLOW)Usage: make build-wheel PACKAGE=<package-name>$(RESET)"; \
echo "$(YELLOW)Available packages: livekit-rtc, livekit-api, livekit-protocol$(RESET)"; \
exit 1; \
fi; \
PACKAGE_PATH="$(MAKEFILE_DIR)/$(PACKAGE)"; \
if [ ! -d "$$PACKAGE_PATH" ]; then \
echo "$(BOLD)$(RED)β Error: Package directory not found: $$PACKAGE_PATH$(RESET)"; \
exit 1; \
fi; \
if [ ! -f "$$PACKAGE_PATH/pyproject.toml" ]; then \
echo "$(BOLD)$(RED)β Error: pyproject.toml not found in $$PACKAGE_PATH$(RESET)"; \
exit 1; \
fi; \
echo "$(CYAN) Package: $(PACKAGE)$(RESET)"; \
echo "$(CYAN) Building in: $$PACKAGE_PATH$(RESET)"; \
cd "$$PACKAGE_PATH" && uv build --out-dir ./dist; \
echo "$(BOLD)$(GREEN)β
Wheel built successfully$(RESET)"; \
echo "$(CYAN) Output: $$PACKAGE_PATH/dist/$(RESET)"
status: ## Show current development environment status
@echo "$(BOLD)$(CYAN)π Current status:$(RESET)"
@echo ""
@set -e; \
echo "$(BOLD)π¦ Packages:$(RESET)"; \
for pkg in livekit livekit-api livekit-protocol; do \
SHOW_OUTPUT=$$(uv pip show $$pkg 2>/dev/null || echo ""); \
if [ -z "$$SHOW_OUTPUT" ]; then \
echo " $$pkg: NOT INSTALLED"; \
elif echo "$$SHOW_OUTPUT" | grep -q "Editable project location:"; then \
VERSION=$$(echo "$$SHOW_OUTPUT" | grep "^Version:" | awk '{print $$2}'); \
LOCATION=$$(echo "$$SHOW_OUTPUT" | grep "Editable project location:" | cut -d' ' -f4-); \
echo " $$pkg: LOCAL (editable) v$$VERSION"; \
echo " path: $$LOCATION"; \
else \
VERSION=$$(echo "$$SHOW_OUTPUT" | grep "^Version:" | awk '{print $$2}'); \
echo " $$pkg: PyPI v$$VERSION"; \
fi; \
done; \
echo ""; \
echo "$(BOLD)π¦ FFI Status:$(RESET)"; \
if [ -n "$$LIVEKIT_LIB_PATH" ]; then \
if [ -f "$$LIVEKIT_LIB_PATH" ]; then \
echo " FFI: CUSTOM (from LIVEKIT_LIB_PATH env var)"; \
echo " path: $$LIVEKIT_LIB_PATH"; \
else \
echo " FFI: CUSTOM (LIVEKIT_LIB_PATH set but file not found)"; \
echo " path: $$LIVEKIT_LIB_PATH"; \
fi; \
else \
FFI_PATH="$(PYTHON_RTC)/livekit/rtc/resources"; \
if [ -d "$$FFI_PATH" ] && { [ -f "$$FFI_PATH/liblivekit_ffi.dylib" ] || [ -f "$$FFI_PATH/liblivekit_ffi.so" ] || [ -f "$$FFI_PATH/livekit_ffi.dll" ]; }; then \
RUST_SUBMODULE_DIR="$$(cd $(RUST_SUBMODULE) 2>/dev/null && pwd || echo "")"; \
CARGO_TOML_PATH="$$RUST_SUBMODULE_DIR/livekit-ffi/Cargo.toml"; \
if [ -f "$$CARGO_TOML_PATH" ]; then \
FFI_VERSION=$$(grep '^version = ' "$$CARGO_TOML_PATH" | head -1 | sed 's/.*"\(.*\)".*/\1/'); \
echo " FFI: PRE-BUILT ARTIFACTS (v$$FFI_VERSION)"; \
else \
echo " FFI: PRE-BUILT ARTIFACTS"; \
fi; \
else \
echo " FFI: NOT AVAILABLE (run 'make download-ffi')"; \
fi; \
fi
doctor: ## Check development environment health
@echo "$(BOLD)$(CYAN)π₯ Running diagnostics...$(RESET)"
@echo ""
@ISSUES=0; \
echo "$(BOLD)π¦ Required Tools:$(RESET)"; \
if command -v uv &> /dev/null; then \
UV_VERSION=$$(uv --version 2>&1 | head -1); \
echo " β uv: $$UV_VERSION"; \
else \
echo " β uv: NOT FOUND"; \
ISSUES=$$((ISSUES + 1)); \
fi; \
if command -v python &> /dev/null; then \
PYTHON_VERSION=$$(python --version 2>&1); \
echo " β python: $$PYTHON_VERSION"; \
else \
echo " β python: NOT FOUND"; \
ISSUES=$$((ISSUES + 1)); \
fi; \
if command -v cargo &> /dev/null; then \
CARGO_VERSION=$$(cargo --version 2>&1); \
echo " β cargo: $$CARGO_VERSION"; \
else \
echo " β cargo: NOT FOUND (required for 'make build-rtc')"; \
fi; \
if command -v git &> /dev/null; then \
GIT_VERSION=$$(git --version 2>&1); \
echo " β git: $$GIT_VERSION"; \
else \
echo " β git: NOT FOUND"; \
ISSUES=$$((ISSUES + 1)); \
fi; \
echo ""; \
echo "$(BOLD)π Repository Structure:$(RESET)"; \
REPO_ROOT=$$(cd $(MAKEFILE_DIR) && git rev-parse --show-toplevel 2>/dev/null || echo ""); \
if [ -n "$$REPO_ROOT" ]; then \
BRANCH=$$(git rev-parse --abbrev-ref HEAD 2>/dev/null || echo "unknown"); \
COMMIT=$$(git rev-parse --short HEAD 2>/dev/null || echo "unknown"); \
echo " β python-sdks: $$REPO_ROOT"; \
echo " Branch: $$BRANCH @ $$COMMIT"; \
fi; \
if [ -d "$(PYTHON_RTC)" ]; then \
echo " β livekit-rtc: $(PYTHON_RTC)"; \
else \
echo " β livekit-rtc: NOT FOUND"; \
ISSUES=$$((ISSUES + 1)); \
fi; \
if [ -d "$(PYTHON_API)" ]; then \
echo " β livekit-api: $(PYTHON_API)"; \
else \
echo " β livekit-api: NOT FOUND"; \
ISSUES=$$((ISSUES + 1)); \
fi; \
if [ -d "$(PYTHON_PROTOCOL)" ]; then \
echo " β livekit-protocol: $(PYTHON_PROTOCOL)"; \
else \
echo " β livekit-protocol: NOT FOUND"; \
ISSUES=$$((ISSUES + 1)); \
fi; \
if [ -d "$(RUST_SUBMODULE)" ]; then \
echo " β rust-sdks: $(RUST_SUBMODULE)"; \
if [ -e "$(RUST_SUBMODULE)/.git" ]; then \
RUST_BRANCH=$$(cd $(RUST_SUBMODULE) && git rev-parse --abbrev-ref HEAD 2>/dev/null || echo "unknown"); \
RUST_COMMIT=$$(cd $(RUST_SUBMODULE) && git rev-parse --short HEAD 2>/dev/null || echo "unknown"); \
echo " Branch: $$RUST_BRANCH @ $$RUST_COMMIT"; \
fi; \
else \
echo " β rust-sdks: NOT FOUND (needed for 'make build-rtc')"; \
fi; \
echo ""; \
echo "$(BOLD)π Current Configuration:$(RESET)"; \
if [ -d ".venv" ]; then \
echo " β Virtual environment: .venv exists"; \
else \
echo " β Virtual environment: .venv not found (run 'make install')"; \
fi; \
for pkg in livekit livekit-api livekit-protocol; do \
SHOW_OUTPUT=$$(uv pip show $$pkg 2>/dev/null || echo ""); \
if [ -z "$$SHOW_OUTPUT" ]; then \
echo " β $$pkg: NOT INSTALLED"; \
elif echo "$$SHOW_OUTPUT" | grep -q "Editable project location:"; then \
VERSION=$$(echo "$$SHOW_OUTPUT" | grep "^Version:" | awk '{print $$2}'); \
echo " β $$pkg: LOCAL (editable) v$$VERSION"; \
else \
VERSION=$$(echo "$$SHOW_OUTPUT" | grep "^Version:" | awk '{print $$2}'); \
echo " β $$pkg: PyPI v$$VERSION"; \
fi; \
done; \
if [ -n "$$LIVEKIT_LIB_PATH" ]; then \
if [ -f "$$LIVEKIT_LIB_PATH" ]; then \
echo " β FFI: Custom build from LIVEKIT_LIB_PATH"; \
else \
echo " β FFI: LIVEKIT_LIB_PATH set but file not found: $$LIVEKIT_LIB_PATH"; \
ISSUES=$$((ISSUES + 1)); \
fi; \
fi; \
echo ""; \
if [ $$ISSUES -eq 0 ]; then \
echo "$(BOLD)$(GREEN)β
All checks passed! Environment is healthy.$(RESET)"; \
else \
echo "$(BOLD)$(RED)β οΈ Found $$ISSUES issue(s). Please fix the errors above.$(RESET)"; \
exit 1; \
fi
bootstrap: ## Sync repo, deps, and assets to a working dev state (safe to re-run)
@echo "$(BOLD)$(CYAN)π Syncing development environment...$(RESET)"
@git submodule update --init --recursive
@git lfs install
@git lfs pull
@$(MAKE) install
@$(MAKE) download-ffi
@echo "$(BOLD)$(GREEN)β Sync complete$(RESET)"