Skip to content

Commit

Permalink
docs: Invoke Nox inside the Poetry environment for testing (#264)
Browse files Browse the repository at this point in the history
  • Loading branch information
cjolowicz authored Feb 5, 2021
1 parent ac9b9a5 commit 38d3a94
Showing 1 changed file with 4 additions and 10 deletions.
14 changes: 4 additions & 10 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,7 @@ Request features on the `Issue Tracker`_.
How to set up your development environment
------------------------------------------

You need Python 3.6+ and the following tools:

- Poetry_
- Nox_
- nox-poetry_
You need Python 3.6+ and Poetry_.

Install the package with development requirements:

Expand All @@ -64,8 +60,6 @@ or the command-line interface:
$ poetry run nox-poetry
.. _Poetry: https://python-poetry.org/
.. _Nox: https://nox.thea.codes/
.. _nox-poetry: https://nox-poetry.readthedocs.io/


How to test the project
Expand All @@ -75,20 +69,20 @@ Run the full test suite:

.. code:: console
$ nox
$ poetry run nox
List the available Nox sessions:

.. code:: console
$ nox --list-sessions
$ poetry run nox --list-sessions
You can also run a specific Nox session.
For example, invoke the unit test suite like this:

.. code:: console
$ nox --session=tests
$ poetry run nox --session=tests
Unit tests are located in the ``tests`` directory,
and are written using the pytest_ testing framework.
Expand Down

0 comments on commit 38d3a94

Please sign in to comment.