Skip to content

Commit 68bc07c

Browse files
committed
Add note on running tests locally
1 parent cec942c commit 68bc07c

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,3 +42,25 @@ For fully working examples, take a look at [`examples/`](https://github.com/tran
4242
## Documentation
4343

4444
See [readthedocs](https://transloadit.readthedocs.io) for full API documentation.
45+
46+
## Contributing
47+
48+
### Running tests
49+
50+
If you have a global installation of `poetry`, you can run the tests with:
51+
52+
```bash
53+
poetry run pytest --cov=transloadit tests
54+
```
55+
56+
If you can't use a global installation of `poetry`, e.g. when using Nix Home Manager, you can create a Python virtual environment and install Poetry there:
57+
58+
```bash
59+
python -m venv .venv && source .venv/bin/activate && pip install poetry && poetry install
60+
```
61+
62+
Then to run the tests:
63+
64+
```bash
65+
source .venv/bin/activate && poetry run pytest --cov=transloadit tests
66+
```

0 commit comments

Comments
 (0)