Skip to content

Commit 77c5932

Browse files
committed
Update development documentation to use poetry run exclusively
Remove poetry shell references and consistently show poetry run prefix for all tox and paver commands in README and bin/setup to avoid confusion.
1 parent 20990a4 commit 77c5932

2 files changed

Lines changed: 12 additions & 10 deletions

File tree

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,14 +35,17 @@ bin/setup
3535
export PATH="$HOME/.pyenv/shims:$PATH"
3636

3737
# Run tests
38-
poetry shell
39-
tox -e py312-core # Quick test on Python 3.12
40-
tox # Full test suite
41-
paver format # Format code
38+
poetry run tox -e py312-core # Quick test on Python 3.12
39+
poetry run tox # Full test suite
40+
41+
# Code formatting and linting
42+
poetry run paver format # Format code (autoflake, isort, black)
43+
poetry run paver check # Check formatting without applying
44+
poetry run paver test # Run tests with coverage
45+
poetry run paver doc # Build documentation
46+
poetry run paver # Default: format + test
4247
```
4348

44-
See `paver --help` for additional tasks.
45-
4649
## Release
4750

4851
1. Update the `version` property in `pyproject.toml`.

bin/setup

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,7 @@ echo " export PATH=\"\$HOME/.pyenv/shims:\$PATH\""
3030
echo ""
3131
echo "Then restart your shell and run:"
3232
echo ""
33-
echo " poetry shell # Enter development environment"
34-
echo " tox -e py312-core # Quick test"
35-
echo " tox # Full test suite"
36-
echo " paver format # Format code"
33+
echo " poetry run tox -e py312-core # Quick test"
34+
echo " poetry run tox # Full test suite"
35+
echo " poetry run paver format # Format code"
3736
echo ""

0 commit comments

Comments
 (0)