forked from filipstrand/mflux
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Makefile
108 lines (93 loc) · 3.5 KB
/
Makefile
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
# Makefile for mflux Python 3.10+ project, using 3.11 as recommended Python as of Sep 2024
PYTHON_VERSION = 3.11
VENV_DIR = .venv
# Default target
.PHONY: all
all: install test
.PHONY: expect-arm64
expect-arm64:
# 🖥️ Checking for compatible machine
@if [ "$$(uname -m)" != "arm64" ]; then \
echo "mflux and MLX is not compatible with older Intel Macs. This project does not support your Mac."; \
exit 1; \
fi
# we "expect" uv but should not install it for the user, let user *choose* to trust a third party installer
.PHONY: expect-uv
expect-uv:
@if ! /usr/bin/which -s uv; then \
echo "You can use classic python -m venv to setup this project, \nbut we officially support using uv for managing this project's environment.\n"; \
echo "Please install uv to continue:\n https://github.com/astral-sh/uv?tab=readme-ov-file#installation"; \
fi
# assume reasonably pre-commit is a safe dependency given its wide support (e.g. GitHub Actions integration)
.PHONY: ensure-pre-commit
@if ! /usr/bin/which -s pre-commit; then \
echo "pre-commit required for submitting commits before pull requests. Using uv tool to install pre-commit."; \
uv tool install pre-commit; \
fi
# assume reasonably that if user has installed uv, they trust ruff from the same team
.PHONY: ensure-ruff
ensure-ruff:
@if ! /usr/bin/which -s ruff; then \
echo "ruff required for code linting and formatting. Using uv tool to install ruff."; \
uv tool install ruff; \
fi
# Create virtual environment with uv
.PHONY: venv-init
venv-init: expect-arm64 expect-uv
# 🏗️ Creating virtual environment with recommended uv tool:
uv python install --quiet $(PYTHON_VERSION)
uv venv --python $(PYTHON_VERSION)
# ✅ "Python $(PYTHON_VERSION) Virtual environment created at $(VENV_DIR)"
# Install dependencies
.PHONY: install
install: venv-init ensure-pre-commit
# 🏗️ Installing dependencies and pre-commit hooks...
uv pip install -e .
# ✅ Dependencies installed.
pre-commit install
# ✅ Pre-commit hooks installed.
# Run linters
.PHONY: lint
lint: ensure-ruff
# 🏗️ Running linters, your files will not be mutated.
# Use 'make check' to auto-apply fixes."
ruff check
# ✅ Linting complete."
# Run formatter (if dev does not do so in their IDE)
.PHONY: format
format: ensure-ruff
# 🏗️ Running formatter, your files will be changed to comply to formatting configs.
ruff format
# display the summaries of diffs in repo, some of these diffs are generated by the formatter
git diff --stat
# ✅ Formatting complete. Please review your git diffs, if any.
# Run ruff auto lint and format via pre-commit hook
.PHONY: check
check: ensure-ruff
# 🏗️ Running pre-commit linter and formatters on files...
@(pre-commit run --all-files)
# Run tests
.PHONY: test
test:
# 🏗️ Running tests...
# mock success stub for future test suite 😜
@true
# ✅ Tests completed
# Clean up
.PHONY: clean
clean:
# 🧼 Cleaning up venv.
rm -rf $(VENV_DIR)
# ✅ Cleaned up venv. Run 'make install' to re-generate.
# Help message
.PHONY: help
help:
@echo "mflux commands:"
@echo " make all - Set up the project and run tests"
@echo " make install - Install project dev dependencies"
@echo " make lint - Run ruff python linter"
@echo " make format - Run ruff code formatter"
@echo " make check - Run linters auto fixes *and* style formatter via pre-commit hook"
@echo " make test - Run tests"
@echo " make clean - Remove the virtual environment"
@echo " make help - Show this help message"