Skip to content

Commit

Permalink
Add instructions to install and update Tox with pipx.
Browse files Browse the repository at this point in the history
  • Loading branch information
wsanchez committed Jan 17, 2024
1 parent 7da4512 commit ab5e692
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,13 @@ Running the Test Suite
~~~~~~~~~~~~~~~~~~~~~~

This project uses Tox_ for running tests.

If you do not have tox installed, the recommended way is to use pipx_::

python3 -m pip install pipx
pipx install tox
pipx upgrade tox

To run all of the default test environments::

tox run
Expand All @@ -49,7 +56,7 @@ To set up a configuration for development, start by copying the example configur

To build and run the server (for development only)::

tox -e exec
tox run -e exec

In your browser, open http://localhost:8080/ to reach the server. Log in as any user in the ``conf/directory.yaml`` directory file. In the ``conf/imsd.conf`` sample configuration file, the users ``Hardware`` and ``Loosy`` are administrators, and in the sample directory, all users have passwords that match their handles. You'll want to log in as one of those to set up an Event.

Expand All @@ -68,8 +75,9 @@ Pull requests in GitHub will run all tests on Travis CI, and all are required to

.. ------------------------------------------------------------------------- ..
.. _Twisted: https://twistedmatrix.com/
.. _Klein: https://klein.readthedocs.io/
.. _Tox: http://tox.readthedocs.io/
.. _Flake8: http://flake8.pycqa.org/
.. _Klein: https://klein.readthedocs.io/
.. _Mypy: http://mypy.readthedocs.io/
.. _pipx: https://pipx.pypa.io/stable/
.. _Tox: http://tox.readthedocs.io/
.. _Twisted: https://twistedmatrix.com/

0 comments on commit ab5e692

Please sign in to comment.