Skip to content

Commit 4ece184

Browse files
committed
show poetry in readme
1 parent cd33e29 commit 4ece184

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,20 @@ pip install python-obfuscator
1919

2020
Requires Python ≥ 3.10.
2121

22+
### From source (contributors)
23+
24+
```bash
25+
pip install -e ".[dev]"
26+
```
27+
28+
Or with [Poetry](https://python-poetry.org/):
29+
30+
```bash
31+
poetry install
32+
```
33+
34+
(`poetry install` pulls dev dependencies from the lockfile; use `poetry run <command>` to run tools inside that environment.)
35+
2236
---
2337

2438
## Quick start — CLI
@@ -158,8 +172,9 @@ The dead-code injector's overhead scales with the number of scopes and loop iter
158172

159173
## Running the test suite
160174

175+
After a dev install ([from source](#from-source-contributors)):
176+
161177
```bash
162-
pip install -e ".[dev]"
163178
pytest
164179
```
165180

@@ -173,6 +188,8 @@ coverage run -m pytest && coverage report
173188
pytest tests/e2e/ -v -s
174189
```
175190

191+
With Poetry, run the same commands through the project environment, for example `poetry run pytest`, `poetry run coverage run -m pytest`, and `poetry run pytest tests/e2e/ -v -s`.
192+
176193
---
177194

178195
## Authors

0 commit comments

Comments
 (0)