Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
Contributing
============

If you want to improve the code base, add a feature or update the
documentation please open a `pull request`_. Feel free to `open an issue`_
beforehand to discuss your plans.

.. _pull request: https://github.com/painless-software/python-cli-test-helpers/pulls
.. _open an issue: https://github.com/painless-software/python-cli-test-helpers/issues

Development
-----------

This project uses Tox to run its test suite. Install it using Pip like this:

.. code-block:: shell

python3 -m pip install tox

Alternatively, if you use `uv`_, install Tox as a development tool like this:

.. code-block:: shell

uv tool install tox --with tox-uv

Usage:

.. code-block:: shell

tox list # list available environments
tox -e py # run tests with local default Python
tox -e lint,format # run a few environments
tox # run entire suite

.. _uv: https://docs.astral.sh/uv/

Documentation
-------------

Build the documentation locally and view it in your Web browser:

.. code-block:: console

$ tox -e clean,docs
...
$ cd docs/_build/html/
$ python -m http.server
Serving HTTP on 0.0.0.0 port 8000 (http://0.0.0.0:8000/) ...

Click on the displayed link to inspect the generated documentation.
15 changes: 2 additions & 13 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ arguments and environment variable values.
.. _docopt: http://docopt.org/
.. _documentation: https://python-cli-test-helpers.readthedocs.io/
.. _CLI Copier template: https://gitlab.com/painless-software/cicd/app/cli
.. _CONTRIBUTING: https://github.com/painless-software/python-cli-test-helpers/blob/main/CONTRIBUTING.rst

.. links-marker

Expand All @@ -61,16 +62,4 @@ effortlessly.
Development
-----------

This project uses Tox to run its test suite. Install and use it locally like
this:

.. code-block:: shell

python3 -m pip install tox

.. code-block:: shell

tox list # list available environments
tox -e lint,py312 # run a few environments
tox -e py # run tests with local default Python
tox # run entire suite
See `CONTRIBUTING`_.
1 change: 1 addition & 0 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../CONTRIBUTING.rst
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Contents
tutorial
other
techniques
contributing

Quotes
------
Expand Down
Loading