Skip to content

Commit 5e4d4df

Browse files
docs: fix DEVELOPMENT.md setup command and tool invocations
The setup command used `uv pip install -e ".[dev]"` which references a non-existent optional-dependencies extra. The project uses [dependency-groups], so the correct command is `uv sync --group dev`. Also updated tool commands from `.venv/bin/` prefix to `uv run`. Closes #143 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 64c4e54 commit 5e4d4df

1 file changed

Lines changed: 13 additions & 14 deletions

File tree

DEVELOPMENT.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,7 @@
1212
curl -LsSf https://astral.sh/uv/install.sh | sh
1313

1414
# Create virtual environment and install dependencies
15-
uv venv --python 3.13
16-
uv pip install -e ".[dev]"
15+
uv sync --group dev
1716
```
1817

1918
## Development Tools
@@ -31,49 +30,49 @@ This project uses modern Python tooling:
3130

3231
```bash
3332
# Run all tests
34-
.venv/bin/pytest
33+
uv run pytest
3534

3635
# Run with verbose output
37-
.venv/bin/pytest -v
36+
uv run pytest -v
3837

3938
# Run with coverage
40-
.venv/bin/pytest --cov=dqlitewire
39+
uv run pytest --cov=dqlitewire
4140
```
4241

4342
## Linting
4443

4544
```bash
4645
# Check for issues
47-
.venv/bin/ruff check src tests
46+
uv run ruff check src tests
4847

4948
# Auto-fix issues
50-
.venv/bin/ruff check --fix src tests
49+
uv run ruff check --fix src tests
5150
```
5251

5352
## Formatting
5453

5554
```bash
5655
# Format all files
57-
.venv/bin/ruff format src tests
56+
uv run ruff format src tests
5857

5958
# Check formatting without modifying
60-
.venv/bin/ruff format --check src tests
59+
uv run ruff format --check src tests
6160
```
6261

6362
## Type Checking
6463

6564
```bash
6665
# Run mypy with strict mode
67-
.venv/bin/mypy src
66+
uv run mypy src
6867
```
6968

7069
## Pre-commit Workflow
7170

7271
Before committing, run all checks:
7372

7473
```bash
75-
.venv/bin/ruff format src tests
76-
.venv/bin/ruff check --fix src tests
77-
.venv/bin/mypy src
78-
.venv/bin/pytest
74+
uv run ruff format src tests
75+
uv run ruff check --fix src tests
76+
uv run mypy src
77+
uv run pytest
7978
```

0 commit comments

Comments
 (0)