The dev script will create a virtualenv environment in a directory called
"venv.mitmproxy", and install all of mitmproxy's development requirements, plus
all optional modules. The primary mitmproxy components - mitmproxy, netlib and
pathod - are all installed "editable", so any changes to the source in the git
checkouts will be reflected live in the virtualenv.

To confirm that you're up and running, activate the virtualenv, and run the
mitmproxy test suite:

Note that the main executables for the project - mitmdump, mitmproxy and
mitmweb - 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:

$ mitmdump --version

For convenience, the project includes an
autoenv file
(.env) that
auto-activates the virtualenv when you cd into the mitmproxy directory.

Testing

If you've followed the procedure above, you already have all the development
requirements installed, and you can simply run the test suite:

nosetests ./test

Please ensure that all patches are accompanied by matching changes in the test
suite. The project maintains 100% test coverage.

Docs

Rendering the documentation requires countershape. After installation, you can render the documentation to the doc like this: