Skip to content

Commit 59b2bdf

Browse files
committed
docs: update docs on running tests
1 parent 83d3fe7 commit 59b2bdf

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,25 @@
2323
`STORAGE_CONFIG` will send any option specified as an argument to `redis.StrictRedis`.
2424

2525
3. Start your bot in text mode: `errbot -T` to give it a shot.
26+
27+
### Running Tests
28+
29+
To run the automated test suite:
30+
31+
1. Create and activate a Python virtual environment:
32+
```bash
33+
python3 -m venv .venv
34+
source .venv/bin/activate
35+
```
36+
2. Install the dependencies and testing requirements:
37+
```bash
38+
pip install -r requirements.txt errbot pytest tox fakeredis
39+
```
40+
3. Run the tests using `pytest` directly:
41+
```bash
42+
pytest
43+
```
44+
Or run both tests and style checks using `tox`:
45+
```bash
46+
tox
47+
```

0 commit comments

Comments
 (0)