Formatting of README
This is really a pretext to get Travis to rebuild, because it's stuck on the wrong commit for the branch.
This commit is contained in:
parent
29bcdc8250
commit
14d6e1d2e3
38
README.rst
38
README.rst
|
@ -3,19 +3,24 @@ mitmproxy
|
||||||
|
|
||||||
|travis| |coveralls| |latest_release| |python_versions|
|
|travis| |coveralls| |latest_release| |python_versions|
|
||||||
|
|
||||||
This repository contains the **mitmproxy** and **pathod** projects, as well as their shared networking library, **netlib**.
|
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.
|
``mitmproxy`` is an interactive, SSL-capable intercepting proxy with a console
|
||||||
|
interface.
|
||||||
|
|
||||||
``mitmdump`` is the command-line version of mitmproxy. Think tcpdump for HTTP.
|
``mitmdump`` is the command-line version of mitmproxy. Think tcpdump for HTTP.
|
||||||
|
|
||||||
``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.
|
``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.
|
||||||
|
|
||||||
|
|
||||||
Documentation & Help
|
Documentation & Help
|
||||||
--------------------
|
--------------------
|
||||||
|
|
||||||
Documentation, tutorials and precompiled binaries can be found on the mitmproxy and pathod websites.
|
Documentation, tutorials and precompiled binaries can be found on the mitmproxy
|
||||||
|
and pathod websites.
|
||||||
|
|
||||||
|mitmproxy_site| |pathod_site|
|
|mitmproxy_site| |pathod_site|
|
||||||
|
|
||||||
|
@ -32,8 +37,8 @@ Hacking
|
||||||
-------
|
-------
|
||||||
|
|
||||||
To get started hacking on mitmproxy, make sure you have Python_ 2.7.x. with
|
To get started hacking on mitmproxy, make sure you have Python_ 2.7.x. with
|
||||||
virtualenv_ installed (you can find installation instructions for virtualenv here_).
|
virtualenv_ installed (you can find installation instructions for virtualenv
|
||||||
Then do the following:
|
here_). Then do the following:
|
||||||
|
|
||||||
.. code-block:: text
|
.. code-block:: text
|
||||||
|
|
||||||
|
@ -42,10 +47,11 @@ Then do the following:
|
||||||
./dev.sh
|
./dev.sh
|
||||||
|
|
||||||
|
|
||||||
The *dev* script will create a virtualenv environment in a directory called "venv",
|
The *dev* script will create a virtualenv environment in a directory called
|
||||||
and install all mandatory and optional dependencies into it.
|
"venv", and install all mandatory and optional dependencies into it. The
|
||||||
The primary mitmproxy components - mitmproxy, netlib and pathod - are installed as "editable",
|
primary mitmproxy components - mitmproxy, netlib and pathod - are installed as
|
||||||
so any changes to the source in the repository will be reflected live in the virtualenv.
|
"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
|
To confirm that you're up and running, activate the virtualenv, and run the
|
||||||
mitmproxy test suite:
|
mitmproxy test suite:
|
||||||
|
@ -56,9 +62,9 @@ mitmproxy test suite:
|
||||||
py.test
|
py.test
|
||||||
|
|
||||||
Note that the main executables for the project - ``mitmdump``, ``mitmproxy``,
|
Note that the main executables for the project - ``mitmdump``, ``mitmproxy``,
|
||||||
``mitmweb``, ``pathod``, and ``pathoc`` - are all created within the virtualenv. After activating the
|
``mitmweb``, ``pathod``, and ``pathoc`` - are all created within the
|
||||||
virtualenv, they will be on your $PATH, and you can run them like any other
|
virtualenv. After activating the virtualenv, they will be on your $PATH, and
|
||||||
command:
|
you can run them like any other command:
|
||||||
|
|
||||||
.. code-block:: text
|
.. code-block:: text
|
||||||
|
|
||||||
|
@ -85,9 +91,9 @@ suite. The project tries to maintain 100% test coverage.
|
||||||
Documentation
|
Documentation
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
The mitmproxy documentation is build using Sphinx_, which is installed automatically if you set up a development
|
The mitmproxy documentation is build using Sphinx_, which is installed
|
||||||
environment as described above.
|
automatically if you set up a development environment as described above. After
|
||||||
After installation, you can render the documentation like this:
|
installation, you can render the documentation like this:
|
||||||
|
|
||||||
.. code-block:: text
|
.. code-block:: text
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue