Skip to content

Commit 15edd77

Browse files
authored
Document using local mutmut in a Poetry codebase (#390)
1 parent f378a3d commit 15edd77

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

CONTRIBUTING.rst

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,23 @@ Running your local version of Mutmut against a test codebase
2828

2929
You can install your local version of Mutmut and run it, including any changes you have made, as normal.
3030

31+
Codebases using pip
32+
^^^^^^^^^^^^^^^^^^^
33+
3134
.. code-block:: console
3235
3336
python -m pip install --editable <path_to_mutmut_codebase>
3437
38+
Codebases using Poetry
39+
^^^^^^^^^^^^^^^^^^^^^^
40+
41+
.. code-block:: console
42+
43+
poetry add --group dev --editable <path_to_mutmut_codebase>
44+
# Install dependecies in your Poetry environment
45+
pip install -r <path_to_mutmut_codebase>/requirements.txt
46+
3547
Documentation about mutmut's architecture
3648
-----------------------------------------
3749

38-
Please see ARCHITECTURE.rst for more details on how mutmut works.
50+
Please see ARCHITECTURE.rst for more details on how mutmut works.

0 commit comments

Comments
 (0)