Skip to content

Commit 02fa7fd

Browse files
committed
clear the README.rst a bit
1 parent a232b7c commit 02fa7fd

File tree

1 file changed

+18
-5
lines changed

1 file changed

+18
-5
lines changed

README.rst

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ Installation
2222
Usage
2323
-----
2424

25+
show-fixture-duplicates
26+
***********************
27+
2528
If you have already installed ``pytest-fixture-tools`` plugin then you can use one of its commands.
2629

2730
``--show-fixture-duplicates`` - will collect all fixtures and print you a list of duplicates for each fixture.
@@ -47,16 +50,27 @@ Output can look like this:
4750
tests/fixtures/order.py:30
4851
tests/unit/api/conftest.py:261
4952

50-
You can also generate the usage fixture graph like that:
53+
fixture-graph
54+
*************
55+
56+
You can generate the usage fixture graph like that:
57+
58+
.. sourcecode:: bash
5159

52-
.. sourcecode::
5360
# on windows gitbash as example
5461
export PATH=$PATH:/c/Program\ Files\ \(x86\)/Graphviz2.38/bin/
5562
pytest --fixture-graph -s
5663

57-
The Output would be like that:
64+
# or you can select the output direcotry like that:
65+
pytest --fixture-graph --fixture-graph-output-dir=./test_output
66+
67+
# you can also change the output type of the graphs (any of graphvis supported outputs types):
68+
pytest --fixture-graph --fixture-graph-type=jpg
69+
70+
The output would be like that:
5871

5972
.. sourcecode::
73+
6074
============================= test session starts =============================
6175
platform win32 -- Python 2.7.10, pytest-3.3.1, py-1.5.2, pluggy-0.6.0
6276
rootdir: C:\Users\ifruchte\Projects\pytest-fixture-tools, inifile: tox.ini
@@ -81,11 +95,10 @@ The Output would be like that:
8195

8296
===================== 6 passed, 1 skipped in 0.29 seconds =====================
8397

84-
would provide this output, that can help under a test that depend on large amount of fixtures:
98+
Final output, that can help with tests that depend on large amount of fixtures:
8599

86100
.. image:: imgs/graph_example.png
87101
:alt: alternate text
88-
:align: right
89102

90103
Contact
91104
-------

0 commit comments

Comments
 (0)