diff options
author | Thomas Kriechbaumer <thomas@kriechbaumer.name> | 2016-06-16 10:08:22 +0200 |
---|---|---|
committer | Thomas Kriechbaumer <thomas@kriechbaumer.name> | 2016-06-16 10:12:22 +0200 |
commit | 1575fd3c9ed933a44b7b89ab85908131bb8067a7 (patch) | |
tree | f760624e8cacc7e5e0b1ee0cf7a1fee68530568d /README.rst | |
parent | 848e7c6c50ec928f029382f141e417a22f7d2553 (diff) | |
download | mitmproxy-1575fd3c9ed933a44b7b89ab85908131bb8067a7.tar.gz mitmproxy-1575fd3c9ed933a44b7b89ab85908131bb8067a7.tar.bz2 mitmproxy-1575fd3c9ed933a44b7b89ab85908131bb8067a7.zip |
update README with tox and flake8 info
Diffstat (limited to 'README.rst')
-rw-r--r-- | README.rst | 19 |
1 files changed, 19 insertions, 0 deletions
@@ -94,6 +94,18 @@ requirements installed, and you can simply run the test suite: Please ensure that all patches are accompanied by matching changes in the test suite. The project tries to maintain 100% test coverage. +You can also use `tox` to run a full suite of tests in Python 2.7 and 3.5, +including a quick test to check documentation and code linting. + +The following tox environments are relevant for local testing: + +.. code-block:: text + + tox -e py27 # runs all tests with Python 2.7 + tox -e py35 # runs all tests with Python 3.5 (partial support only) + tox -e docs # runs a does-it-compile check on the documentation + tox -e lint # runs the linter for coding style checks + Documentation ------------- @@ -120,6 +132,13 @@ contribute and collaborate. Please stick to the guidelines in `PEP8`_ and the `Google Style Guide`_ unless there's a very good reason not to. +This is automatically enforced on every PR. If we detect a linting error, the +PR checks will fail and block merging. We are using this command to check for style compliance: + +.. code-block:: text + + flake8 --jobs 8 --count mitmproxy netlib pathod examples test + .. |mitmproxy_site| image:: https://shields.mitmproxy.org/api/https%3A%2F%2F-mitmproxy.org-blue.svg :target: https://mitmproxy.org/ |