Skip to content

Commit

Permalink
docs: Merge pull request #1174 from svinota/ci-docs-update
Browse files Browse the repository at this point in the history
docs: update ci docs and Python version

Bug-Url: #1174
  • Loading branch information
svinota authored Feb 12, 2024
2 parents 7246c9d + 8ab0c85 commit eef9470
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ Using source, requires make and nox
Requirements
------------

Python >= 3.6
Python >= 3.8

Links
-----
Expand Down
20 changes: 18 additions & 2 deletions tests/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Requirements
============

* nox
* python >= 3.6
* python >= 3.8
* `-r requirements.dev.txt`

Run tests
Expand All @@ -31,14 +31,30 @@ for those who prefer::
# using nox
$ nox --list
$ nox -e unit # run only unit tests
$ nox -e unit -- '{"pdb": true}' # provide a session config
$ nox # run all the tests

# using make
$ sudo make test # run the default sessions
$ make nox session=unit # run only unit tests
$ make nox session=openbsd # OpenBSD tests

It is possible to provide a session config. This example runs
only one particular test module starting debugger on failure::

# using nox
$ nox -e linux -- '{"pdb": true, "sub": "test_ipr/test_rule.py"}'

# using make
$ make nox \
session=linux \
noxconfig='{"pdb": true, "sub": "test_ipr/test_rule.py"}'

Get code coverage and run PDB on failures::

# using nox
$ nox -e linux -- '{"pdb": true, "coverage": true}'

# using make
$ make nox \
session=linux \
noxconfig='{"pdb": true, "coverage": true}'

0 comments on commit eef9470

Please sign in to comment.