Skip to content

Commit 86c83e7

Browse files
committed
docs: add dev-deps install and test/lint commands to README
Closes #966. The Development section explained the pre-push hook but not how to install dev dependencies or run the same checks manually.
1 parent 5513b20 commit 86c83e7

1 file changed

Lines changed: 27 additions & 0 deletions

File tree

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -297,6 +297,33 @@ If you're contributing to this project, run the initial setup script to install
297297

298298
This installs a pre-push hook that runs lint checks before pushing, matching the CI workflow. To skip the hook temporarily, use `git push --no-verify`.
299299

300+
### Setting Up Your Environment
301+
302+
Install the package with its development dependencies:
303+
304+
```bash
305+
pip install -e ".[dev]"
306+
```
307+
308+
### Running Lint, Typecheck, and Tests
309+
310+
```bash
311+
# Lint (auto-fix) and format
312+
python -m ruff check src/ tests/ --fix
313+
python -m ruff format src/ tests/
314+
315+
# Typecheck
316+
python -m mypy src/
317+
318+
# Run all tests
319+
python -m pytest tests/
320+
321+
# Run a specific test file
322+
python -m pytest tests/test_client.py
323+
```
324+
325+
These are the same checks the CI workflow and pre-push hook run.
326+
300327
### Building Wheels Locally
301328

302329
To build wheels with the bundled Claude Code CLI:

0 commit comments

Comments
 (0)