diff options
| author | Maximilian Hils <git@maximilianhils.com> | 2016-06-16 16:28:18 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-06-16 16:28:18 -0700 |
| commit | 4836f3f12b352ac63c8cb3e07209b19fb39b2d31 (patch) | |
| tree | c356221ccba077e6f09e04aeaccd85539c522d36 | |
| parent | 1fc2db85fa339f9b134d45c15d2ad4cf3d681070 (diff) | |
| parent | daa31c0fe063369fa17db9e3ace7b6dcf95cbb81 (diff) | |
| download | mitmproxy-4836f3f12b352ac63c8cb3e07209b19fb39b2d31.tar.gz mitmproxy-4836f3f12b352ac63c8cb3e07209b19fb39b2d31.tar.bz2 mitmproxy-4836f3f12b352ac63c8cb3e07209b19fb39b2d31.zip | |
Merge pull request #1263 from Kriechi/readme
Update README with information about tox & flake8.
| -rw-r--r-- | .codecov.yml (renamed from codecov.yml) | 0 | ||||
| -rw-r--r-- | README.rst | 22 |
2 files changed, 22 insertions, 0 deletions
diff --git a/codecov.yml b/.codecov.yml index db247200..db247200 100644 --- a/codecov.yml +++ b/.codecov.yml @@ -94,6 +94,21 @@ 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 + +We are in the middle of transitioning to Python 3, so please make sure all tests +pass in Python 2.7 and 3.5. Running `tox` ensure all necessary tests are executed. + Documentation ------------- @@ -120,6 +135,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/ |