Skip to content

Commit ef49b2e

Browse files
committed
add some docs for running tests
1 parent 7ebeba8 commit ef49b2e

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,3 +71,27 @@ For example, to upgrade the `isort` package only:
7171
``` bash
7272
nox -s "pip-compile-3.12(formatters)" -- --no-upgrade --upgrade-package=isort
7373
```
74+
75+
## Running tests
76+
77+
This project contains several tests to verify functionality.
78+
To run the tests, do the following:
79+
80+
1. Install test requirements.
81+
82+
``` bash
83+
python -m pip install -r requirements/tests.in -c requirements/tests.txt
84+
```
85+
86+
1. From the repository root, run `pytest` in one of the following ways:
87+
88+
``` bash
89+
# Run all tests
90+
pytest
91+
92+
# Run a specific test class
93+
pytest tests/test_parser_functions.py::TestParseArguments
94+
95+
# Run a specific test function
96+
pytest tests/test_parser_functions.py::TestParseArguments::test_with_url_arg
97+
```

0 commit comments

Comments
 (0)