This repository contains the mitmproxy and pathod projects, as well as their shared networking library, netlib.
mitmproxy is an interactive, SSL-capable intercepting proxy with a console interface.
mitmdump is the command-line version of mitmproxy. Think tcpdump for HTTP.
pathod are perverse HTTP client and server applications designed to let you craft almost any conceivable HTTP request, including ones that creatively violate the standards.
Documentation & Help
Documentation, tutorials and precompiled binaries can be found on the mitmproxy and pathod websites.
The latest documentation for mitmproxy is also available on ReadTheDocs.
You can join our developer chat on Slack.
git clone https://github.com/mitmproxy/mitmproxy.git cd mitmproxy ./dev
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, netlib 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:
. venv/bin/activate # venv\Scripts\activate.bat on Windows py.test
Note that the main executables for the project -
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
If you've followed the procedure above, you already have all the development 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.
The mitmproxy documentation is build using Sphinx, which is installed automatically if you set up a development environment as described above. After installation, you can render the documentation like this:
cd docs make clean make html make livehtml
The last command invokes sphinx-autobuild, which watches the Sphinx directory and rebuilds the documentation when a change is detected.