Commits

eduardo schettino committed 2fa88ba

breaklines

Comments (0)

Files changed (1)

 How it works ?
 ================
 
-`pytest-incremental` is a `pytest <http://pytest.org/>`_ plug-in. So if you can run your test suite with pytest you can use `pytest-incremental`.
+`pytest-incremental` is a `pytest <http://pytest.org/>`_ plug-in.
+So if you can run your test suite with pytest you can use `pytest-incremental`.
 
-Note that pytest has support to run standard unittest's and nose's tests. So even if you don't use pytest as a test framework you might be able to use it as a test runner.
+Note that pytest has support to run standard unittest's and nose's tests.
+So even if you don't use pytest as a test framework you might be able to
+use it as a test runner.
 
-The plug-in will analyze your python source files and through its imports define the dependencies of the modules. `doit <http://python-doit.sourceforge.net>`_ is used to keep track of the dependencies and save results. The plug-in will modify how pytest collect your tests. pytest do the rest of the job of actually running the tests and reporting the results.
+The plug-in will analyze your python source files and through its imports
+define the dependencies of the modules.
+`doit <http://pydoit.org>`_ is used to keep track of
+the dependencies and save results.
+The plug-in will modify how pytest collect your tests.
+pytest do the rest of the job of actually running the tests and
+reporting the results.
 
 
 Install
 local installation
 --------------------
 
-You can also just grab the plug-in `module <https://bitbucket.org/schettino72/pytest-incremental/src/tip/pytest_incremental.py>`_ file and put in your project path. Then enable it (check `pytest docs <http://pytest.org/plugins.html#requiring-loading-plugins-in-a-test-module-or-conftest-file>`_).
+You can also just grab the plug-in
+`module <https://bitbucket.org/schettino72/pytest-incremental/src/tip/pytest_incremental.py>`_
+file and put in your project path.
+Then enable it (check `pytest docs <http://pytest.org/plugins.html#requiring-loading-plugins-in-a-test-module-or-conftest-file>`_).
 
 
 Usage
   $ py.test --incremental
 
 
-You can also enable it by default adding the following line to your ``pytest.ini``::
+You can also enable it by default adding the following
+line to your ``pytest.ini``::
 
   [pytest]
   addopts = --incremental
 watched packages
 ------------------
 
-By default all modules collected by py.test will be used as dependencies if imported. In order to limit or extend the watched folders you must use the parameter ``--watch-path``
+By default all modules collected by py.test will be used as dependencies
+if imported. In order to limit or extend the watched folders you must use
+the parameter ``--watch-path``
 
 
-This can be used in case you want to watch for changes in modules that are in another project. For example if you are testing ``my_lib`` and want to check for changes in dependencies from your `py3rd` package::
+This can be used in case you want to watch for changes in modules that are
+in another project.
+For example if you are testing ``my_lib`` and want to check for changes
+in dependencies from your `py3rd` package::
 
 $ py.test --incremental --watch-pkg my_lib --watch-pkg ../py3rd-trunk/py3rd
 
 
   $ py.test  tests/test_foo.py
 
-It is required to use ``--watch-path`` because the source files will not be collected by py.test
+It is required to use ``--watch-path`` because the source files will not
+be collected by py.test
 
 You should call::
 
 
  $ py.test --list-dependencies
 
-for better visualization you can create a graph file in "dot" format (see `graphviz <http://www.graphviz.org/>`_ ::
+for better visualization you can create a graph file in "dot" format
+(see `graphviz <http://www.graphviz.org/>`_ ::
 
  $ py.test --graph-dependencies
  $ dot -Tpng -o imports.png imports.dot