Skip to content

docs: add dev-deps install and test/lint commands to README #1089

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.

Sign up for GitHub

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

Open
Socialpranker wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add dev-deps install and test/lint commands to README #1089

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 27 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,6 +297,33 @@ If you're contributing to this project, run the initial setup script to install

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`.

### Setting Up Your Environment

Install the package with its development dependencies:

```bash
pip install -e ".[dev]"
```

### Running Lint, Typecheck, and Tests

```bash
# Lint (auto-fix) and format
python -m ruff check src/ tests/ --fix
python -m ruff format src/ tests/

# Typecheck
python -m mypy src/

# Run all tests
python -m pytest tests/

# Run a specific test file
python -m pytest tests/test_client.py
```

These are the same checks the CI workflow and pre-push hook run.

### Building Wheels Locally

To build wheels with the bundled Claude Code CLI:
Expand Down