aboutsummaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorMaximilian Hils <git@maximilianhils.com>2019-11-20 18:40:43 +0100
committerMaximilian Hils <git@maximilianhils.com>2019-11-20 18:45:36 +0100
commit6ad7b575bbeec73ed94c8735d4c0b8500aa8e412 (patch)
treee39b424b1c6d6646b699418c13da79733d5b8033 /README.rst
parent3a7ca3e1e7cc4e0d1d8a6702cbf443f7cddaf00f (diff)
downloadmitmproxy-6ad7b575bbeec73ed94c8735d4c0b8500aa8e412.tar.gz
mitmproxy-6ad7b575bbeec73ed94c8735d4c0b8500aa8e412.tar.bz2
mitmproxy-6ad7b575bbeec73ed94c8735d4c0b8500aa8e412.zip
simplify install instructions
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst24
1 files changed, 14 insertions, 10 deletions
diff --git a/README.rst b/README.rst
index 3b5fc489..31ce730d 100644
--- a/README.rst
+++ b/README.rst
@@ -57,7 +57,16 @@ please consider contributing in the following areas:
Development Setup
-----------------
-To get started hacking on mitmproxy, please follow the `advanced installation`_ steps to install mitmproxy from source, but stop right before running ``pip3 install mitmproxy``. Instead, do the following:
+To get started hacking on mitmproxy, please install a recent version of Python (we require at least 3.6).
+The following commands should work on your system:
+
+.. code-block:: bash
+
+ python3 --version
+ python3 -m pip --help
+ python3 -m venv --help
+
+If all of this run successfully, do the following:
.. code-block:: bash
@@ -86,17 +95,12 @@ Testing
-------
If you've followed the procedure above, you already have all the development
-requirements installed, and you can run the full test suite (including tests for code style and documentation) with tox_:
-
-.. code-block:: bash
-
- tox
-
-To run complete tests with a full coverage report, you can use the following command:
+requirements installed, and you can run the full test suite with tox_:
.. code-block:: bash
- tox -- --verbose --cov-report=term
+ tox -e py # runs Python tests
+ tox -e lint # checks code style
For speedier testing, we recommend you run `pytest`_ directly on individual test files or folders:
@@ -105,7 +109,7 @@ For speedier testing, we recommend you run `pytest`_ directly on individual test
cd test/mitmproxy/addons
pytest --cov mitmproxy.addons.anticache --cov-report term-missing --looponfail test_anticache.py
-As pytest does not check the code style, you probably want to run ``tox -e lint`` before committing your changes.
+Pytest does not check the code style, so you want to run ``tox -e lint`` again before committing.
Please ensure that all patches are accompanied by matching changes in the test
suite. The project tries to maintain 100% test coverage and enforces this strictly for some parts of the codebase.