Skip to content

build: 🔨 update justfile with recipes from Sprout #75

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 20, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion justfile
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
just --list --unsorted

# Run all build-related recipes in the justfile
run-all: install-deps format-python check-python test-python check-security check-spelling check-commits build-website
run-all: install-deps format-python check-python check-unused test-python check-security check-spelling check-commits build-website

# Install Python package dependencies
install-deps:
Expand Down Expand Up @@ -54,3 +54,23 @@ check-security:
# Check for spelling errors in files
check-spelling:
uv run typos

# Build the documentation as PDF using Quarto
build-pdf:
# To let Quarto know where python is.
export QUARTO_PYTHON=.venv/bin/python3
uv run quarto install tinytex
# For generating images from Mermaid diagrams
uv run quarto install chromium
uv run quarto render --profile pdf --to pdf
find docs -name "mermaid-figure-*.png" -delete

# Check for unused code in the package and its tests
check-unused:
# exit code=0: No unused code was found
# exit code=3: Unused code was found
# Three confidence values:
# - 100 %: function/method/class argument, unreachable code
# - 90 %: import
# - 60 %: attribute, class, function, method, property, variable
uv run vulture src/ tests/