Skip to content

Commit

Permalink
chore[docs]: update readme about testing
Browse files Browse the repository at this point in the history
- add comments to `quicktest.sh` explaining usage.
- remove `tests_require` from `setup.py` as that has been deprecated
- remove `pytest-runner` from `setup.py`
- update readme to reference quicktest.sh
  • Loading branch information
charles-cooper committed Jan 13, 2025
1 parent db8dcc7 commit 71c9c1f
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ be a bit behind the latest version found in the master branch of this repository

```bash
make dev-init
python setup.py test
./quicktest.sh -m "not fuzzing"
```

## Developing (working on the compiler)
Expand Down
11 changes: 10 additions & 1 deletion quicktest.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,17 @@

# examples:
# ./quicktest.sh
# ./quicktest.sh -m "not fuzzing"
# ./quicktest.sh -m "not fuzzing" -n<cpu cores - 2> (this is the most useful)
# ./quicktest.sh -m "not fuzzing" -n0
# ./quicktest.sh tests/.../mytest.py

# run pytest but bail out on first error
# useful for dev workflow
# useful for dev workflow.

pytest -q -s --instafail -x --disable-warnings "$@"

# useful options include:
# -n0 (uses only one core but faster startup)
# -nauto (uses only one core but faster startup)
# -m "not fuzzing" - skip slow/fuzzing tests
3 changes: 1 addition & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,7 @@ def _global_version(version):
"importlib-metadata",
"wheel",
],
setup_requires=["pytest-runner", "setuptools_scm>=7.1.0,<8.0.0"],
tests_require=extras_require["test"],
setup_requires=["setuptools_scm>=7.1.0,<8.0.0"],
extras_require=extras_require,
entry_points={
"console_scripts": [
Expand Down

0 comments on commit 71c9c1f

Please sign in to comment.