2016-02-15 20:13:06 +00:00
mitmproxy
^^^^^^^^^
2019-11-19 20:36:20 +00:00
|ci_status| |coverage| |latest_release| |python_versions|
2016-02-15 18:43:55 +00:00
2016-10-19 22:56:38 +00:00
This repository contains the **mitmproxy** and **pathod** projects.
2016-02-15 18:43:55 +00:00
2018-09-15 11:54:18 +00:00
`` mitmproxy `` is an interactive, SSL/TLS-capable intercepting proxy with a console
interface for HTTP/1, HTTP/2, and WebSockets.
2016-02-15 18:43:55 +00:00
`` mitmdump `` is the command-line version of mitmproxy. Think tcpdump for HTTP.
2016-12-27 19:47:47 +00:00
`` mitmweb `` is a web-based interface for mitmproxy.
2016-06-02 04:43:46 +00:00
`` pathoc `` and `` 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.
2016-02-15 18:43:55 +00:00
Documentation & Help
--------------------
2016-06-19 08:55:32 +00:00
2019-11-04 15:05:43 +00:00
General information, tutorials, and precompiled binaries can be found on the mitmproxy website.
2016-02-15 18:43:55 +00:00
2016-10-17 20:06:32 +00:00
|mitmproxy_site|
2016-06-19 08:55:32 +00:00
2018-03-27 15:25:15 +00:00
The documentation for mitmproxy is available on our website:
2016-02-15 18:43:55 +00:00
2018-09-15 11:54:18 +00:00
|mitmproxy_docs_stable| |mitmproxy_docs_master|
2016-02-15 18:43:55 +00:00
2019-11-04 15:03:04 +00:00
If you have questions on how to use mitmproxy, please
ask them on StackOverflow!
2016-06-19 08:55:32 +00:00
2019-11-04 15:03:04 +00:00
|mitmproxy_stackoverflow|
2016-06-19 08:55:32 +00:00
2017-01-29 22:06:50 +00:00
Join our developer chat on Slack if you would like to contribute to mitmproxy itself.
2016-02-15 18:43:55 +00:00
|slack|
2016-06-02 17:57:26 +00:00
Installation
------------
2018-03-27 15:23:01 +00:00
The installation instructions are `here <https://docs.mitmproxy.org/stable/overview-installation> `__ .
2016-06-03 01:25:56 +00:00
If you want to contribute changes, keep on reading.
2016-06-02 17:57:26 +00:00
2017-01-29 23:28:56 +00:00
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:
2019-11-04 15:05:43 +00:00
- **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 on StackOverflow_, creating minimal, complete and verifiable examples or test cases for existing bug reports, updating documentation, or fixing minor bugs that have recently been reported.
2017-01-29 23:28:56 +00:00
- **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.
2016-06-02 17:57:26 +00:00
2017-01-29 23:28:56 +00:00
Development Setup
-----------------
2016-02-15 18:43:55 +00:00
2019-11-20 17:40:43 +00:00
To get started hacking on mitmproxy, please install a recent version of Python (we require at least 3.6).
The following commands should work on your system:
.. code-block :: bash
python3 --version
python3 -m pip --help
python3 -m venv --help
If all of this run successfully, do the following:
2016-02-15 18:43:55 +00:00
2017-03-29 11:36:51 +00:00
.. code-block :: bash
2016-02-15 18:43:55 +00:00
git clone https://github.com/mitmproxy/mitmproxy.git
cd mitmproxy
2017-01-29 22:06:50 +00:00
./dev.sh # "powershell .\dev.ps1" on Windows
2016-02-15 18:43:55 +00:00
2017-01-29 23:38:40 +00:00
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
2016-06-02 04:43:46 +00:00
"editable", so any changes to the source in the repository will be reflected
live in the virtualenv.
2016-02-15 18:43:55 +00:00
2017-01-29 22:06:50 +00:00
The main executables for the project - `` mitmdump `` , `` mitmproxy `` ,
2016-06-02 04:43:46 +00:00
`` 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:
2016-02-15 18:43:55 +00:00
2017-03-29 11:36:51 +00:00
.. code-block :: bash
2016-02-15 18:43:55 +00:00
2017-01-29 23:38:40 +00:00
. venv/bin/activate # "venv\Scripts\activate" on Windows
2016-02-15 18:43:55 +00:00
mitmdump --version
Testing
-------
If you've followed the procedure above, you already have all the development
2019-12-31 15:03:45 +00:00
requirements installed, and you can run the basic test suite with tox_:
2018-02-19 17:26:52 +00:00
.. code-block :: bash
2020-04-08 20:11:52 +00:00
tox -e py # runs Python tests
2019-12-31 15:03:45 +00:00
Our CI system has additional tox environments that are run on every pull request and branch on GitHub.
2018-02-19 17:26:52 +00:00
2017-01-30 15:46:22 +00:00
For speedier testing, we recommend you run `pytest`_ directly on individual test files or folders:
2016-06-16 08:08:22 +00:00
2017-03-29 11:36:51 +00:00
.. code-block :: bash
2016-06-16 08:08:22 +00:00
2017-01-29 22:06:50 +00:00
cd test/mitmproxy/addons
2019-04-02 14:29:14 +00:00
pytest --cov mitmproxy.addons.anticache --cov-report term-missing --looponfail test_anticache.py
2017-01-29 22:06:50 +00:00
2019-12-31 15:03:45 +00:00
Pytest does not check the code style, so you want to run `` tox -e flake8 `` again before committing.
2016-06-16 08:08:22 +00:00
2017-01-29 22:06:50 +00:00
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.
2016-02-15 18:43:55 +00:00
2016-02-17 19:38:51 +00:00
Documentation
2016-04-10 03:14:42 +00:00
-------------
2016-02-15 18:43:55 +00:00
All new documentation
This patch does a lot.
- Ditch sphinx in favor of hugo. This gives us complete control of the layout
and presentation of our docs. Henceforth, docs will be hosted on our website
rather than ReadTheDocs.
- Create a simple, clean doc layout and theme.
- Remove large parts of the documentaion. I've ditched anything that was a)
woefully out of date, b) too detailed, or c) too hard to maintain in the long
term.
- Huge updates to the docs themselves: completely rewrite addons documentation,
add docs for core concepts like commands and options, and revise and tweak a
lot of the existing docs.
With this patch, we're also changing the way we publish and maintain the docs.
From now on, we don't publish docs for every release. Instead, the website will
contain ONE set of docs for each major release. The online docs will be updated
if needed as minor releases are made. Docs are free to improve during minor
releases, but anything that changes behaviour sufficiently to require a doc
change warrants a new major release. This also leaves us free to progressively
update and improve docs out of step with our release cadence.
With this new scheme, I feel CI over the docs is less important. I've removed
it for now, but won't object if someone wants to add it back in.
2018-02-22 04:21:34 +00:00
The following tools are required to build the mitmproxy docs:
- Hugo_
- modd_
2016-02-15 18:43:55 +00:00
2017-03-29 11:36:51 +00:00
.. code-block :: bash
2016-02-15 18:43:55 +00:00
cd docs
All new documentation
This patch does a lot.
- Ditch sphinx in favor of hugo. This gives us complete control of the layout
and presentation of our docs. Henceforth, docs will be hosted on our website
rather than ReadTheDocs.
- Create a simple, clean doc layout and theme.
- Remove large parts of the documentaion. I've ditched anything that was a)
woefully out of date, b) too detailed, or c) too hard to maintain in the long
term.
- Huge updates to the docs themselves: completely rewrite addons documentation,
add docs for core concepts like commands and options, and revise and tweak a
lot of the existing docs.
With this patch, we're also changing the way we publish and maintain the docs.
From now on, we don't publish docs for every release. Instead, the website will
contain ONE set of docs for each major release. The online docs will be updated
if needed as minor releases are made. Docs are free to improve during minor
releases, but anything that changes behaviour sufficiently to require a doc
change warrants a new major release. This also leaves us free to progressively
update and improve docs out of step with our release cadence.
With this new scheme, I feel CI over the docs is less important. I've removed
it for now, but won't object if someone wants to add it back in.
2018-02-22 04:21:34 +00:00
modd
2016-02-15 18:43:55 +00:00
2017-01-29 22:06:50 +00:00
Code Style
----------
2016-05-31 21:55:43 +00:00
Keeping to a consistent code style throughout the project makes it easier to
contribute and collaborate. Please stick to the guidelines in
2016-05-31 22:17:10 +00:00
`PEP8`_ and the `Google Style Guide`_ unless there's a very
2016-05-31 21:55:43 +00:00
good reason not to.
2016-06-16 08:08:22 +00:00
This is automatically enforced on every PR. If we detect a linting error, the
2016-11-03 07:51:22 +00:00
PR checks will fail and block merging. You can run our lint checks yourself
2020-04-08 20:11:52 +00:00
with the following commands:
2016-06-16 08:08:22 +00:00
2017-03-29 11:36:51 +00:00
.. code-block :: bash
2016-06-16 08:08:22 +00:00
2020-04-08 20:11:52 +00:00
tox -e flake8
tox -e mypy # checks static types
2016-06-16 08:08:22 +00:00
2016-02-15 18:43:55 +00:00
2019-11-04 15:03:04 +00:00
.. |mitmproxy_site| image :: https://shields.mitmproxy.org/badge/https%3A%2F%2F-mitmproxy.org-blue.svg
2016-02-15 18:43:55 +00:00
:target: https://mitmproxy.org/
:alt: mitmproxy.org
2019-11-04 15:03:04 +00:00
.. |mitmproxy_docs_stable| image :: https://shields.mitmproxy.org/badge/docs-stable-brightgreen.svg
2018-03-27 15:23:01 +00:00
:target: https://docs.mitmproxy.org/stable/
2018-03-27 15:25:15 +00:00
:alt: mitmproxy documentation stable
2018-09-15 11:54:18 +00:00
2019-11-04 15:03:04 +00:00
.. |mitmproxy_docs_master| image :: https://shields.mitmproxy.org/badge/docs-master-brightgreen.svg
2018-03-27 15:25:15 +00:00
:target: https://docs.mitmproxy.org/master/
:alt: mitmproxy documentation master
2016-02-15 18:43:55 +00:00
2019-11-04 15:03:04 +00:00
.. |mitmproxy_stackoverflow| image :: https://shields.mitmproxy.org/stackexchange/stackoverflow/t/mitmproxy?color=orange&label=stackoverflow%20questions
:target: https://stackoverflow.com/questions/tagged/mitmproxy
:alt: StackOverflow: mitmproxy
2016-06-19 08:55:32 +00:00
2016-02-15 18:43:55 +00:00
.. |slack| image :: http://slack.mitmproxy.org/badge.svg
:target: http://slack.mitmproxy.org/
:alt: Slack Developer Chat
2019-11-19 20:36:20 +00:00
.. |ci_status| image :: https://github.com/mitmproxy/mitmproxy/workflows/CI/badge.svg?branch=master
:target: https://github.com/mitmproxy/mitmproxy/actions?query=branch%3Amaster
:alt: Continuous Integration Status
2016-02-15 18:43:55 +00:00
2017-02-11 10:54:59 +00:00
.. |coverage| image :: https://shields.mitmproxy.org/codecov/c/github/mitmproxy/mitmproxy/master.svg?label=codecov
2016-06-07 07:32:29 +00:00
:target: https://codecov.io/gh/mitmproxy/mitmproxy
2016-02-15 18:43:55 +00:00
:alt: Coverage Status
2016-02-15 20:13:06 +00:00
.. |latest_release| image :: https://shields.mitmproxy.org/pypi/v/mitmproxy.svg
2016-02-15 18:43:55 +00:00
:target: https://pypi.python.org/pypi/mitmproxy
:alt: Latest Version
2016-02-15 20:13:06 +00:00
.. |python_versions| image :: https://shields.mitmproxy.org/pypi/pyversions/mitmproxy.svg
2016-02-15 18:43:55 +00:00
:target: https://pypi.python.org/pypi/mitmproxy
:alt: Supported Python versions
2017-01-29 22:06:50 +00:00
.. _virtualenv: https://virtualenv.pypa.io/
2017-01-30 15:46:22 +00:00
.. _`pytest`: http://pytest.org/
2017-01-29 22:06:50 +00:00
.. _tox: https://tox.readthedocs.io/
All new documentation
This patch does a lot.
- Ditch sphinx in favor of hugo. This gives us complete control of the layout
and presentation of our docs. Henceforth, docs will be hosted on our website
rather than ReadTheDocs.
- Create a simple, clean doc layout and theme.
- Remove large parts of the documentaion. I've ditched anything that was a)
woefully out of date, b) too detailed, or c) too hard to maintain in the long
term.
- Huge updates to the docs themselves: completely rewrite addons documentation,
add docs for core concepts like commands and options, and revise and tweak a
lot of the existing docs.
With this patch, we're also changing the way we publish and maintain the docs.
From now on, we don't publish docs for every release. Instead, the website will
contain ONE set of docs for each major release. The online docs will be updated
if needed as minor releases are made. Docs are free to improve during minor
releases, but anything that changes behaviour sufficiently to require a doc
change warrants a new major release. This also leaves us free to progressively
update and improve docs out of step with our release cadence.
With this new scheme, I feel CI over the docs is less important. I've removed
it for now, but won't object if someone wants to add it back in.
2018-02-22 04:21:34 +00:00
.. _Hugo: https://gohugo.io/
.. _modd: https://github.com/cortesi/modd
2016-05-31 22:17:10 +00:00
.. _PEP8: https://www.python.org/dev/peps/pep-0008
2017-01-29 22:06:50 +00:00
.. _`Google Style Guide`: https://google.github.io/styleguide/pyguide.html
2019-11-04 15:05:43 +00:00
.. _StackOverflow: https://stackoverflow.com/questions/tagged/mitmproxy
2018-01-15 17:53:57 +00:00
.. _`good first contributions`: https://github.com/mitmproxy/mitmproxy/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22
