File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -26,6 +26,7 @@ Key features:
2626
2727This project uses:
2828- Python 3.10+
29+ - [ just] ( https://github.com/casey/just ) for command running (see also https://just.systems/ )
2930- [ uv] ( https://github.com/astral-sh/uv ) for dependency management
3031- [ ruff] ( https://github.com/astral-sh/ruff ) for linting and formatting
3132- [ mypy] ( https://github.com/python/mypy ) for type checking
@@ -49,7 +50,7 @@ uv pip install --editable . -G dev
4950
5051``` bash
5152# Run all tests
52- make test
53+ just test
5354# or directly with pytest
5455uv run pytest
5556
@@ -60,7 +61,7 @@ uv run pytest tests/test_doctest_docutils.py
6061uv run pytest tests/test_doctest_docutils.py::test_function_name
6162
6263# Run tests with test watcher
63- make start
64+ just start
6465# or
6566uv run ptw .
6667
@@ -72,26 +73,26 @@ uv run ptw . --now --doctest-modules
7273
7374``` bash
7475# Run ruff for linting
75- make ruff
76+ just ruff
7677# or directly
7778uv run ruff check .
7879
7980# Format code with ruff
80- make ruff_format
81+ just ruff-format
8182# or directly
8283uv run ruff format .
8384
8485# Run ruff linting with auto-fixes
8586uv run ruff check . --fix --show-fixes
8687
8788# Run mypy for type checking
88- make mypy
89+ just mypy
8990# or directly
9091uv run mypy src tests
9192
9293# Watch mode for linting (using entr)
93- make watch_ruff
94- make watch_mypy
94+ just watch-ruff
95+ just watch-mypy
9596```
9697
9798### Development Workflow
@@ -108,13 +109,13 @@ Follow this workflow for code changes (see `.cursor/rules/dev-loop.mdc`):
108109
109110``` bash
110111# Build documentation
111- make build_docs
112+ just build-docs
112113
113114# Start documentation server with auto-reload
114- make start_docs
115+ just start-docs
115116
116117# Update documentation CSS/JS
117- make design_docs
118+ just design-docs
118119```
119120
120121## Code Architecture
You can’t perform that action at this time.
0 commit comments