From 0919e385146d495a65fdb73ad263b40caee5787a Mon Sep 17 00:00:00 2001 From: Maximilian Hils Date: Sun, 29 Jan 2017 22:08:57 +0100 Subject: remove outdated architecture section from docs --- docs/dev/architecture.rst | 14 -------------- docs/index.rst | 1 - docs/schematics/architecture.pdf | Bin 182446 -> 0 bytes docs/schematics/architecture.png | Bin 87365 -> 0 bytes docs/schematics/architecture.vsdx | Bin 60922 -> 0 bytes 5 files changed, 15 deletions(-) delete mode 100644 docs/dev/architecture.rst delete mode 100644 docs/schematics/architecture.pdf delete mode 100644 docs/schematics/architecture.png delete mode 100644 docs/schematics/architecture.vsdx diff --git a/docs/dev/architecture.rst b/docs/dev/architecture.rst deleted file mode 100644 index e7995141..00000000 --- a/docs/dev/architecture.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _architecture: - -Architecture -============ - -To give you a better understanding of how mitmproxy works, mitmproxy's -high-level architecture is detailed in the following graphic: - -.. image:: ../schematics/architecture.png - -:download:`architecture.pdf <../schematics/architecture.pdf>` - -Please don't refrain from asking any further -questions on the mailing list, the Slack channel or the GitHub issue tracker. diff --git a/docs/index.rst b/docs/index.rst index a40a5f62..63e0bbf5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -80,7 +80,6 @@ :hidden: :caption: Hacking - dev/architecture dev/testing dev/sslkeylogfile diff --git a/docs/schematics/architecture.pdf b/docs/schematics/architecture.pdf deleted file mode 100644 index 77f5ad58..00000000 Binary files a/docs/schematics/architecture.pdf and /dev/null differ diff --git a/docs/schematics/architecture.png b/docs/schematics/architecture.png deleted file mode 100644 index 67d6c718..00000000 Binary files a/docs/schematics/architecture.png and /dev/null differ diff --git a/docs/schematics/architecture.vsdx b/docs/schematics/architecture.vsdx deleted file mode 100644 index c4ff13d2..00000000 Binary files a/docs/schematics/architecture.vsdx and /dev/null differ -- cgit v1.2.3 From e10fb22f9cf223d75b2a8f5a1656921fd0c2b7a6 Mon Sep 17 00:00:00 2001 From: Maximilian Hils Date: Sun, 29 Jan 2017 22:09:45 +0100 Subject: remove outdated testing section from docs --- docs/dev/testing.rst | 47 ----------------------------------------------- docs/index.rst | 1 - 2 files changed, 48 deletions(-) delete mode 100644 docs/dev/testing.rst diff --git a/docs/dev/testing.rst b/docs/dev/testing.rst deleted file mode 100644 index b86efce1..00000000 --- a/docs/dev/testing.rst +++ /dev/null @@ -1,47 +0,0 @@ -.. _testing: - -Testing -======= - -All the mitmproxy projects strive to maintain 100% code coverage. In general, -patches and pull requests will be declined unless they're accompanied by a -suitable extension to the test suite. - -Our tests are written for the `py.test`_ or nose_ test frameworks. -At the point where you send your pull request, a command like this: - ->>> py.test --cov mitmproxy - -Should give output something like this: - -.. code-block:: none - - > ---------- coverage: platform darwin, python 2.7.2-final-0 -- - > Name Stmts Miss Cover Missing - > ---------------------------------------------------- - > mitmproxy/__init__ 0 0 100% - > mitmproxy/app 4 0 100% - > mitmproxy/cmdline 100 0 100% - > mitmproxy/controller 69 0 100% - > mitmproxy/dump 150 0 100% - > mitmproxy/encoding 39 0 100% - > mitmproxy/flowfilter 201 0 100% - > mitmproxy/flow 891 0 100% - > mitmproxy/proxy 427 0 100% - > mitmproxy/script 27 0 100% - > mitmproxy/utils 133 0 100% - > mitmproxy/version 4 0 100% - > ---------------------------------------------------- - > TOTAL 2045 0 100% - > ---------------------------------------------------- - > Ran 251 tests in 11.864s - - -There are exceptions to the coverage requirement - for instance, much of the -console interface code can't sensibly be unit tested. These portions are -excluded from coverage analysis either in the **.coveragerc** file, or using -**#pragma no-cover** directives. To keep our coverage analysis relevant, we use -these measures as sparingly as possible. - -.. _nose: https://nose.readthedocs.org/en/latest/ -.. _py.test: https://pytest.org/ diff --git a/docs/index.rst b/docs/index.rst index 63e0bbf5..9fcededc 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -80,7 +80,6 @@ :hidden: :caption: Hacking - dev/testing dev/sslkeylogfile .. Indices and tables -- cgit v1.2.3 From edb96f69f52daa53547a90a392dbdd51cdcfa7f5 Mon Sep 17 00:00:00 2001 From: Maximilian Hils Date: Sun, 29 Jan 2017 22:10:37 +0100 Subject: add contributing section that redirects to README --- docs/dev/contributing.rst | 11 +++++++++++ docs/index.rst | 3 ++- docs/install.rst | 4 ++-- 3 files changed, 15 insertions(+), 3 deletions(-) create mode 100644 docs/dev/contributing.rst diff --git a/docs/dev/contributing.rst b/docs/dev/contributing.rst new file mode 100644 index 00000000..8e04c270 --- /dev/null +++ b/docs/dev/contributing.rst @@ -0,0 +1,11 @@ +.. _contributing: + +Contributing +============ + +As an open source project, **mitmproxy** welcomes contributions of all forms. + +Please head over to the README_ to get started! 😃 + + +.. _README: https://github.com/mitmproxy/mitmproxy/blob/master/README.rst \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 9fcededc..8ba14f54 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -78,8 +78,9 @@ .. toctree:: :hidden: - :caption: Hacking + :caption: Development + dev/contributing dev/sslkeylogfile .. Indices and tables diff --git a/docs/install.rst b/docs/install.rst index 9a2aca0a..b9524897 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -139,11 +139,11 @@ Latest Development Version If you would like to install mitmproxy directly from the master branch on GitHub or would like to get set up to contribute to the project, install the dependencies as you would for a regular installation from source. Then see the -Hacking_ section of the README on GitHub. You can check your system information +project's README_ on GitHub. You can check your system information by running: ``mitmproxy --version`` -.. _Hacking: https://github.com/mitmproxy/mitmproxy/blob/master/README.rst#hacking +.. _README: https://github.com/mitmproxy/mitmproxy/blob/master/README.rst .. _releases: https://github.com/mitmproxy/mitmproxy/releases .. _mitmproxy.org: https://mitmproxy.org/ .. _`Python website`: https://www.python.org/downloads/windows/ -- cgit v1.2.3 From a384dea62bae36ce1db10d1ff3eade0ed49ccbb6 Mon Sep 17 00:00:00 2001 From: Maximilian Hils Date: Sun, 29 Jan 2017 23:06:50 +0100 Subject: rework README dev sections --- README.rst | 61 +++++++++++++++++++++++++------------------------------------ 1 file changed, 25 insertions(+), 36 deletions(-) diff --git a/README.rst b/README.rst index 1725708f..b8da7696 100644 --- a/README.rst +++ b/README.rst @@ -37,7 +37,7 @@ each other solve problems, and come up with new ideas for the project. |mitmproxy_discourse| -Join our developer chat on Slack if you would like to hack on mitmproxy itself. +Join our developer chat on Slack if you would like to contribute to mitmproxy itself. |slack| @@ -49,42 +49,32 @@ The installation instructions are `here `__). Then do the following: +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: .. code-block:: text - sudo apt-get install python3-pip python3-dev libffi-dev libssl-dev libtiff5-dev libjpeg8-dev zlib1g-dev libwebp-dev git clone https://github.com/mitmproxy/mitmproxy.git cd mitmproxy - ./dev.sh # powershell .\dev.ps1 on Windows + ./dev.sh # "powershell .\dev.ps1" on Windows -The *dev* script will create a virtualenv environment in a directory called +The *dev* script will create a `virtualenv`_ environment in a directory called "venv3.5", and install all mandatory and optional dependencies into it. The primary mitmproxy components - mitmproxy and pathod - are installed as "editable", so any changes to the source in the repository will be reflected live in the virtualenv. -To confirm that you're up and running, activate the virtualenv, and run the -mitmproxy test suite: - -.. code-block:: text - - . venv3.5/bin/activate # venv\Scripts\activate on Windows - py.test - -Note that the main executables for the project - ``mitmdump``, ``mitmproxy``, +The main executables for the project - ``mitmdump``, ``mitmproxy``, ``mitmweb``, ``pathod``, and ``pathoc`` - are all created within the virtualenv. After activating the virtualenv, they will be on your $PATH, and you can run them like any other command: .. code-block:: text + . venv3.5/bin/activate # "venv\Scripts\activate" on Windows mitmdump --version For convenience, the project includes an autoenv_ file (`.env`_) that @@ -95,26 +85,23 @@ Testing ------- If you've followed the procedure above, you already have all the development -requirements installed, and you can simply run the test suite: +requirements installed, and you can run the full test suite (including tests for code style and documentation) with tox_: .. code-block:: text - py.test - -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 the full suite of tests, including a quick test -to check documentation and code linting. + tox -The following tox environments are relevant for local testing: +For speedier testing, we recommend you run `py.test`_ directly on individual test files or folders: .. code-block:: text - tox -e py35 # runs all tests with Python 3.5 - tox -e docs # runs a does-it-compile check on the documentation - tox -e lint # runs the linter for coding style checks + cd test/mitmproxy/addons + py.test --cov mitmproxy.addons.anticache --looponfail test_anticache.py + +As py.test does not check the code style, you probably want to run ``tox -e lint`` before committing your changes. +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. Documentation ------------- @@ -133,8 +120,8 @@ installation, you can render the documentation like this: The last command invokes `sphinx-autobuild`_, which watches the Sphinx directory and rebuilds the documentation when a change is detected. -Style ------ +Code Style +---------- Keeping to a consistent code style throughout the project makes it easier to contribute and collaborate. Please stick to the guidelines in @@ -186,11 +173,13 @@ with the following command: :target: https://pypi.python.org/pypi/mitmproxy :alt: Supported Python versions -.. _Python: https://www.python.org/ -.. _virtualenv: http://virtualenv.readthedocs.org/en/latest/ -.. _autoenv: https://github.com/kennethreitz/autoenv +.. _`advanced installation`: http://docs.mitmproxy.org/en/latest/install.html#advanced-installation +.. _virtualenv: https://virtualenv.pypa.io/ .. _.env: https://github.com/mitmproxy/mitmproxy/blob/master/.env +.. _autoenv: https://github.com/kennethreitz/autoenv +.. _`py.test`: http://pytest.org/ +.. _tox: https://tox.readthedocs.io/ .. _Sphinx: http://sphinx-doc.org/ .. _sphinx-autobuild: https://pypi.python.org/pypi/sphinx-autobuild .. _PEP8: https://www.python.org/dev/peps/pep-0008 -.. _Google Style Guide: https://google.github.io/styleguide/pyguide.html +.. _`Google Style Guide`: https://google.github.io/styleguide/pyguide.html -- cgit v1.2.3 From f570c57006a79f31739d5270a4b72eae1b1ab740 Mon Sep 17 00:00:00 2001 From: Maximilian Hils Date: Mon, 30 Jan 2017 00:28:56 +0100 Subject: add contributing section to README, remove autoenv --- .env | 6 ------ README.rst | 20 ++++++++++++-------- 2 files changed, 12 insertions(+), 14 deletions(-) delete mode 100644 .env diff --git a/.env b/.env deleted file mode 100644 index a1b8db7f..00000000 --- a/.env +++ /dev/null @@ -1,6 +0,0 @@ -DIR="$( dirname "${BASH_SOURCE[0]}" )" -ACTIVATE_DIR="$(if [ -f "$DIR/venv/bin/activate" ]; then echo 'bin'; else echo 'Scripts'; fi;)" -if [ -z "$VIRTUAL_ENV" ] && [ -f "$DIR/venv/$ACTIVATE_DIR/activate" ]; then - echo "Activating mitmproxy virtualenv..." - source "$DIR/venv/$ACTIVATE_DIR/activate" -fi diff --git a/README.rst b/README.rst index b8da7696..1c69caf8 100644 --- a/README.rst +++ b/README.rst @@ -48,9 +48,17 @@ Installation The installation instructions are `here `__. If you want to contribute changes, keep on reading. +Contributing +------------ + +As an open source project, mitmproxy welcomes contributions of all forms. If you would like to bring the project forward, +please consider contributing in the following areas: + +- **Maintenance:** We are *incredibly* thankful for individuals who are stepping up and helping with maintenance. This includes (but is not limited to) triaging issues, reviewing pull requests and picking up stale ones, helping out other users in our forums_, creating minimal, complete and verifiable examples or test cases for existing bug reports, updating documentation, or fixing minor bugs that have recently been reported. +- **Code Contributions:** We actively mark issues that we consider are `good first contributions`_. If you intend to work on a larger contribution to the project, please come talk to us first. -Setting Up a Development Environment ------------------------------------- +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: @@ -77,10 +85,6 @@ you can run them like any other command: . venv3.5/bin/activate # "venv\Scripts\activate" on Windows mitmdump --version -For convenience, the project includes an autoenv_ file (`.env`_) that -auto-activates the virtualenv when you cd into the mitmproxy directory. - - Testing ------- @@ -175,11 +179,11 @@ with the following command: .. _`advanced installation`: http://docs.mitmproxy.org/en/latest/install.html#advanced-installation .. _virtualenv: https://virtualenv.pypa.io/ -.. _.env: https://github.com/mitmproxy/mitmproxy/blob/master/.env -.. _autoenv: https://github.com/kennethreitz/autoenv .. _`py.test`: http://pytest.org/ .. _tox: https://tox.readthedocs.io/ .. _Sphinx: http://sphinx-doc.org/ .. _sphinx-autobuild: https://pypi.python.org/pypi/sphinx-autobuild .. _PEP8: https://www.python.org/dev/peps/pep-0008 .. _`Google Style Guide`: https://google.github.io/styleguide/pyguide.html +.. _forums: https://discourse.mitmproxy.org/ +.. _`good first contributions`: https://github.com/mitmproxy/mitmproxy/issues?q=is%3Aissue+is%3Aopen+label%3Agood-first-contribution -- cgit v1.2.3 From 3fe2f9578a19729196d5d775923beb597c8be032 Mon Sep 17 00:00:00 2001 From: Maximilian Hils Date: Mon, 30 Jan 2017 00:38:40 +0100 Subject: always use 'venv' as virtualenv folder --- README.rst | 8 ++++---- dev.ps1 | 7 +++---- dev.sh | 18 ++++++++---------- 3 files changed, 15 insertions(+), 18 deletions(-) diff --git a/README.rst b/README.rst index 1c69caf8..a8f02bee 100644 --- a/README.rst +++ b/README.rst @@ -69,9 +69,9 @@ To get started hacking on mitmproxy, please follow the `advanced installation`_ ./dev.sh # "powershell .\dev.ps1" on Windows -The *dev* script will create a `virtualenv`_ environment in a directory called -"venv3.5", and install all mandatory and optional dependencies into it. The -primary mitmproxy components - mitmproxy and pathod - are installed as +The *dev* script will create a `virtualenv`_ environment in a directory called "venv" +and install all mandatory and optional dependencies into it. The primary +mitmproxy components - mitmproxy and pathod - are installed as "editable", so any changes to the source in the repository will be reflected live in the virtualenv. @@ -82,7 +82,7 @@ you can run them like any other command: .. code-block:: text - . venv3.5/bin/activate # "venv\Scripts\activate" on Windows + . venv/bin/activate # "venv\Scripts\activate" on Windows mitmdump --version Testing diff --git a/dev.ps1 b/dev.ps1 index e6b9f610..ee0fc131 100644 --- a/dev.ps1 +++ b/dev.ps1 @@ -1,20 +1,19 @@ $ErrorActionPreference = "Stop" -$VENV = ".\venv" $pyver = python --version if($pyver -notmatch "3\.[5-9]") { Write-Warning "Unexpected Python version, expected Python 3.5 or above: $pyver" } -python -m venv $VENV --copies -& $VENV\Scripts\activate.ps1 +python -m venv .\venv --copies +& .\venv\Scripts\activate.ps1 python -m pip install --disable-pip-version-check -U pip cmd /c "pip install -r requirements.txt 2>&1" echo @" - * Created virtualenv environment in $VENV. + * Created virtualenv environment in .\venv. * Installed all dependencies into the virtualenv. * Activated virtualenv environment. diff --git a/dev.sh b/dev.sh index 95e8b773..a90b48ab 100755 --- a/dev.sh +++ b/dev.sh @@ -2,16 +2,14 @@ set -e set -x -PYVERSION=${1:-3.5} -VENV="venv$PYVERSION" +echo "Creating dev environment in ./venv..." -echo "Creating dev environment in $VENV using Python $PYVERSION" - -python$PYVERSION -m venv "$VENV" -. "$VENV/bin/activate" -pip$PYVERSION install -U pip setuptools -pip$PYVERSION install -r requirements.txt +python3 -m venv venv +. venv/bin/activate +pip3 install -U pip setuptools +pip3 install -r requirements.txt echo "" -echo "* Virtualenv created in $VENV and all dependencies installed." -echo "* You can now activate the $(python --version) virtualenv with this command: \`. $VENV/bin/activate\`" +echo " * Created virtualenv environment in ./venv." +echo " * Installed all dependencies into the virtualenv." +echo " * You can now activate the $(python3 --version) virtualenv with this command: \`. venv/bin/activate\`" \ No newline at end of file -- cgit v1.2.3 From 4746ce939fbbf08a37c3d6ea458b1bd37af866fb Mon Sep 17 00:00:00 2001 From: Maximilian Hils Date: Mon, 30 Jan 2017 16:46:22 +0100 Subject: README: py.test -> pytest --- README.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index a8f02bee..ba87419e 100644 --- a/README.rst +++ b/README.rst @@ -95,14 +95,14 @@ requirements installed, and you can run the full test suite (including tests for tox -For speedier testing, we recommend you run `py.test`_ directly on individual test files or folders: +For speedier testing, we recommend you run `pytest`_ directly on individual test files or folders: .. code-block:: text cd test/mitmproxy/addons - py.test --cov mitmproxy.addons.anticache --looponfail test_anticache.py + pytest --cov mitmproxy.addons.anticache --looponfail test_anticache.py -As py.test does not check the code style, you probably want to run ``tox -e lint`` before committing your changes. +As pytest does not check the code style, you probably want to run ``tox -e lint`` before committing your changes. 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. @@ -179,7 +179,7 @@ with the following command: .. _`advanced installation`: http://docs.mitmproxy.org/en/latest/install.html#advanced-installation .. _virtualenv: https://virtualenv.pypa.io/ -.. _`py.test`: http://pytest.org/ +.. _`pytest`: http://pytest.org/ .. _tox: https://tox.readthedocs.io/ .. _Sphinx: http://sphinx-doc.org/ .. _sphinx-autobuild: https://pypi.python.org/pypi/sphinx-autobuild -- cgit v1.2.3