Skip to content

Commit ba0df62

Browse files
committed
Update README.md to reflect uv usage
1 parent 0496634 commit ba0df62

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

tests/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,27 +24,27 @@ We are using the following modules and packages for our unit tests:
2424
We also use the following package as a test runner:
2525
- [pytest](https://docs.pytest.org/en/6.2.x/)
2626

27-
To ensure the results you obtain on your personal machine are comparable to those generated in the CI, please make sure to run your tests with the virtual environment defined by our [Poetry Project](/pyproject.toml). To run your tests with `poetry`, we've provided the following "script" shortcuts:
27+
To ensure the results you obtain on your personal machine are comparable to those generated in the CI, please make sure to run your tests with the virtual environment defined by our [UV Project](/pyproject.toml). To run your tests with `uv`, we've provided the following "script" shortcuts:
2828

29-
- `poetry run task test` will run `pytest`.
30-
- `poetry run task test path/to/test.py` will run a specific test.
31-
- `poetry run task test-cov` will run `pytest` with `pytest-cov`.
32-
- `poetry run task report` will generate a coverage report of the tests you've run with `poetry run task test-cov`. If you append the `-m` flag to this command, the report will include the lines and branches not covered by tests in addition to the test coverage report.
29+
- `uv run task test` will run `pytest`.
30+
- `uv run task test path/to/test.py` will run a specific test.
31+
- `uv run task test-cov` will run `pytest` with `pytest-cov`.
32+
- `uv run task report` will generate a coverage report of the tests you've run with `uv run task test-cov`. If you append the `-m` flag to this command, the report will include the lines and branches not covered by tests in addition to the test coverage report.
3333

34-
If you want a coverage report, make sure to run the tests with `poetry run task test-cov` *first*.
34+
If you want a coverage report, make sure to run the tests with `uv run task test-cov` *first*.
3535

3636
## Running tests
3737
There are multiple ways to run the tests, which one you use will be determined by your goal, and stage in development.
3838

3939
When actively developing, you'll most likely be working on one portion of the codebase, and as a result, won't need to run the entire test suite.
4040
To run just one file, and save time, you can use the following command:
4141
```shell
42-
poetry run task test <path/to/file.py>
42+
uv run task test <path/to/file.py>
4343
```
4444

4545
For example:
4646
```shell
47-
poetry run task test tests/bot/exts/test_cogs.py
47+
uv run task test tests/bot/exts/test_cogs.py
4848
```
4949
will run the test suite in the `test_cogs` file.
5050

@@ -53,7 +53,7 @@ If you'd like to collect coverage as well, you can append `--cov` to the command
5353

5454
If you're done and are preparing to commit and push your code, it's a good idea to run the entire test suite as a sanity check:
5555
```shell
56-
poetry run task test
56+
uv run task test
5757
```
5858

5959
## Writing tests

0 commit comments

Comments
 (0)