Magic-Mirror/mitmproxy
1
0
Fork 0
mirror of https://github.com/mitmproxy/mitmproxy.git synced 2024-12-14 08:38:32 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

use own shields instance, update pathod readme

Browse Source
This commit is contained in:
Maximilian Hils 2016-02-15 21:13:06 +01:00
parent a78c6f1cb0
commit 3d9a5157e7
7 changed files with 90 additions and 118 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.rst
View File

@ -1,3 +1,6 @@
mitmproxy
^^^^^^^^^
|travis| |coveralls| |downloads| |latest_release| |python_versions|
This repository contains the **mitmproxy** and **pathod** projects, as well as their shared networking library, **netlib**.
@ -97,11 +100,11 @@ The last command invokes `sphinx-autobuild`_, which watches the Sphinx directory
the documentation when a change is detected.
.. |mitmproxy_site| image:: https://img.shields.io/badge/https%3A%2F%2F-mitmproxy.org-blue.svg
.. |mitmproxy_site| image:: https://shields.mitmproxy.org/badge/https%3A%2F%2F-mitmproxy.org-blue.svg
:target: https://mitmproxy.org/
:alt: mitmproxy.org
.. |pathod_site| image:: https://img.shields.io/badge/https%3A%2F%2F-pathod.net-blue.svg
.. |pathod_site| image:: https://shields.mitmproxy.org/badge/https%3A%2F%2F-pathod.net-blue.svg
:target: https://pathod.net/
:alt: pathod.net
@ -109,31 +112,27 @@ the documentation when a change is detected.
:target: http://docs.mitmproxy.org/en/latest/
:alt: mitmproxy documentation
.. |pathod_docs| image:: https://readthedocs.org/projects/mitmproxy/badge/
:target: http://pathod.net/docs/pathod
:alt: pathod documentation
.. |slack| image:: http://slack.mitmproxy.org/badge.svg
:target: http://slack.mitmproxy.org/
:alt: Slack Developer Chat
.. |travis| image:: https://img.shields.io/travis/mitmproxy/mitmproxy/master.svg
.. |travis| image:: https://shields.mitmproxy.org/travis/mitmproxy/mitmproxy/master.svg
:target: https://travis-ci.org/mitmproxy/mitmproxy
:alt: Build Status
.. |coveralls| image:: https://img.shields.io/coveralls/mitmproxy/mitmproxy/master.svg
.. |coveralls| image:: https://shields.mitmproxy.org/coveralls/mitmproxy/mitmproxy/master.svg
:target: https://coveralls.io/r/mitmproxy/mitmproxy
:alt: Coverage Status
.. |downloads| image:: https://img.shields.io/pypi/dm/mitmproxy.svg?color=orange
.. |downloads| image:: https://shields.mitmproxy.org/pypi/dm/mitmproxy.svg?color=orange
:target: https://pypi.python.org/pypi/mitmproxy
:alt: Downloads
.. |latest_release| image:: https://img.shields.io/pypi/v/mitmproxy.svg
.. |latest_release| image:: https://shields.mitmproxy.org/pypi/v/mitmproxy.svg
:target: https://pypi.python.org/pypi/mitmproxy
:alt: Latest Version
.. |python_versions| image:: https://img.shields.io/pypi/pyversions/mitmproxy.svg
.. |python_versions| image:: https://shields.mitmproxy.org/pypi/pyversions/mitmproxy.svg
:target: https://pypi.python.org/pypi/mitmproxy
:alt: Supported Python versions

22
mitmproxy/README.rst
View File

@ -1,11 +1,10 @@
|travis| |coveralls| |downloads| |latest_release| |python_versions|
``mitmproxy`` is an interactive, SSL-capable man-in-the-middle proxy for HTTP
``mitmproxy`` is an interactive, SSL/TLS-capable man-in-the-middle proxy for HTTP
with a console interface.
``mitmdump`` is the command-line version of mitmproxy. Think tcpdump for HTTP.
``libmproxy`` is the library that mitmproxy and mitmdump are built on.
Features
--------
@ -17,12 +16,13 @@ Features
- Reverse proxy mode to forward traffic to a specified server.
- Transparent proxy mode on OSX and Linux.
- Make scripted changes to HTTP traffic using Python.
- SSL certificates for interception are generated on the fly.
- SSL/TLS certificates for interception are generated on the fly.
- And much, much more.
``mitmproxy`` is tested and developed on OSX, Linux and OpenBSD.
``mitmproxy`` is tested and developed on Mac OSX and Linux.
On Windows, only mitmdump is supported, which does not have a graphical user interface.
Documentation & Help
--------------------
@ -31,7 +31,7 @@ mitmproxy website.
|mitmproxy_site|
Installation Instructions are available in the docs.
Installation Instructions are available in the documentation.
|mitmproxy_docs|
@ -40,7 +40,7 @@ You can join our developer chat on Slack.
|slack|
.. |mitmproxy_site| image:: https://img.shields.io/badge/https%3A%2F%2F-mitmproxy.org-blue.svg
.. |mitmproxy_site| image:: https://shields.mitmproxy.org/badge/https%3A%2F%2F-mitmproxy.org-blue.svg
:target: https://mitmproxy.org/
:alt: mitmproxy.org
@ -52,22 +52,22 @@ You can join our developer chat on Slack.
:target: http://slack.mitmproxy.org/
:alt: Slack Developer Chat
.. |travis| image:: https://img.shields.io/travis/mitmproxy/mitmproxy/master.svg
.. |travis| image:: https://shields.mitmproxy.org/travis/mitmproxy/mitmproxy/master.svg
:target: https://travis-ci.org/mitmproxy/mitmproxy
:alt: Build Status
.. |coveralls| image:: https://img.shields.io/coveralls/mitmproxy/mitmproxy/master.svg
.. |coveralls| image:: https://shields.mitmproxy.org/coveralls/mitmproxy/mitmproxy/master.svg
:target: https://coveralls.io/r/mitmproxy/mitmproxy
:alt: Coverage Status
.. |downloads| image:: https://img.shields.io/pypi/dm/mitmproxy.svg?color=orange
.. |downloads| image:: https://shields.mitmproxy.org/pypi/dm/mitmproxy.svg?color=orange
:target: https://pypi.python.org/pypi/mitmproxy
:alt: Downloads
.. |latest_release| image:: https://img.shields.io/pypi/v/mitmproxy.svg
.. |latest_release| image:: https://shields.mitmproxy.org/pypi/v/mitmproxy.svg
:target: https://pypi.python.org/pypi/mitmproxy
:alt: Latest Version
.. |python_versions| image:: https://img.shields.io/pypi/pyversions/mitmproxy.svg
.. |python_versions| image:: https://shields.mitmproxy.org/pypi/pyversions/mitmproxy.svg
:target: https://pypi.python.org/pypi/mitmproxy
:alt: Supported Python versions

16
netlib/README.rst
View File

@ -1,4 +1,4 @@
|travis| |coveralls| |downloads| |latest-release| |python-versions|
|travis| |coveralls| |downloads| |latest_release| |python_versions|
Netlib is a collection of network utility classes, used by the pathod and
mitmproxy projects. It differs from other projects in some fundamental
@ -7,28 +7,28 @@ This means that protocols are implemented as small, well-contained and flexible
functions, and are designed to allow misbehaviour when needed.
Hacking
-------
Development
-----------
If you'd like to work on netlib, check out the instructions in mitmproxy's README_.
.. |travis| image:: https://img.shields.io/travis/mitmproxy/netlib/master.svg
.. |travis| image:: https://shields.mitmproxy.org/travis/mitmproxy/netlib/master.svg
:target: https://travis-ci.org/mitmproxy/netlib
:alt: Build Status
.. |coveralls| image:: https://img.shields.io/coveralls/mitmproxy/netlib/master.svg
.. |coveralls| image:: https://shields.mitmproxy.org/coveralls/mitmproxy/netlib/master.svg
:target: https://coveralls.io/r/mitmproxy/netlib
:alt: Coverage Status
.. |downloads| image:: https://img.shields.io/pypi/dm/netlib.svg?color=orange
.. |downloads| image:: https://shields.mitmproxy.org/pypi/dm/netlib.svg?color=orange
:target: https://pypi.python.org/pypi/netlib
:alt: Downloads
.. |latest-release| image:: https://img.shields.io/pypi/v/netlib.svg
.. |latest_release| image:: https://shields.mitmproxy.org/pypi/v/netlib.svg
:target: https://pypi.python.org/pypi/netlib
:alt: Latest Version
.. |python-versions| image:: https://img.shields.io/pypi/pyversions/netlib.svg
.. |python_versions| image:: https://shields.mitmproxy.org/pypi/pyversions/netlib.svg
:target: https://pypi.python.org/pypi/netlib
:alt: Supported Python versions

44
pathod/README.mkd
View File

@ -1,44 +0,0 @@
[![Build Status](https://img.shields.io/travis/mitmproxy/pathod/master.svg)](https://travis-ci.org/mitmproxy/pathod)
[![Code Health](https://landscape.io/github/mitmproxy/pathod/master/landscape.svg?style=flat)](https://landscape.io/github/mitmproxy/pathod/master)
[![Coverage Status](https://img.shields.io/coveralls/mitmproxy/pathod/master.svg)](https://coveralls.io/r/mitmproxy/pathod)
[![Downloads](https://img.shields.io/pypi/dm/pathod.svg?color=orange)](https://pypi.python.org/pypi/pathod)
[![Latest Version](https://img.shields.io/pypi/v/pathod.svg)](https://pypi.python.org/pypi/pathod)
[![Supported Python versions](https://img.shields.io/pypi/pyversions/pathod.svg)](https://pypi.python.org/pypi/pathod)
__pathod__ is a collection of pathological tools for testing and torturing HTTP
clients and servers. The project has three components:
- __pathod__, an pathological HTTP daemon.
- __pathoc__, a perverse HTTP client.
- __libpathod.test__, an API for easily using __pathod__ and __pathoc__ in unit tests.
# Documentation
The pathod documentation is self-hosted. Just fire up pathod, like so:
./pathod
And then browse to:
http://localhost:9999
You can always view the documentation for the latest release at the pathod
website:
http://pathod.net
# Installing
If you already have __pip__ on your system, installing __pathod__ and its
dependencies is dead simple:
pip install pathod
The project has the following dependencies:
* [netlib](https://github.com/mitmproxy/netlib)
* [requests](http://docs.python-requests.org/en/latest/index.html)
The project's test suite uses the
[nose](http://nose.readthedocs.org/en/latest/) unit testing framework.

60
pathod/README.rst Normal file
View File

@ -0,0 +1,60 @@
pathod
^^^^^^
|travis| |coveralls| |downloads| |latest_release| |python_versions|
**pathod** is a collection of pathological tools for testing and torturing HTTP
clients and servers. The project has three components:
- ``pathod``, an pathological HTTP daemon.
- ``pathoc``, a perverse HTTP client.
- ``libpathod.test``, an API for easily using pathod and pathoc in unit tests.
Installing
----------
If you already have **pip** on your system, installing **pathod** and its
dependencies is dead simple:
.. code-block:: text
pip install pathod
Documentation
-------------
The pathod documentation is self-hosted. Just fire up pathod, like so:
.. code-block:: text
./pathod
And then browse to:
`<http://localhost:9999>`_
You can always view the documentation for the latest release at the pathod
website:
`<http://pathod.net>`_
.. |travis| image:: https://shields.mitmproxy.org/travis/mitmproxy/pathod/master.svg
:target: https://travis-ci.org/mitmproxy/pathod
:alt: Build Status
.. |coveralls| image:: https://shields.mitmproxy.org/coveralls/mitmproxy/pathod/master.svg
:target: https://coveralls.io/r/mitmproxy/pathod
:alt: Coverage Status
.. |downloads| image:: https://shields.mitmproxy.org/pypi/dm/pathod.svg?color=orange
:target: https://pypi.python.org/pypi/pathod
:alt: Downloads
.. |latest_release| image:: https://shields.mitmproxy.org/pypi/v/pathod.svg
:target: https://pypi.python.org/pypi/pathod
:alt: Latest Version
.. |python_versions| image:: https://shields.mitmproxy.org/pypi/pyversions/pathod.svg
:target: https://pypi.python.org/pypi/pathod
:alt: Supported Python versions

43
pathod/README.txt
View File

@ -1,43 +0,0 @@
**pathod** is a collection of pathological tools for testing and torturing HTTP
clients and servers. The project has three components:
- **pathod**, an pathological HTTP daemon.
- **pathoc**, a perverse HTTP client.
- **libpathod.test**, an API for easily using pathod and pathoc in unit tests.
Documentation
-------------
The pathod documentation is self-hosted. Just fire up pathod, like so:
./pathod
And then browse to:
http://localhost:9999
You can always view the documentation for the latest release at the pathod
website:
http://pathod.net
Installing
----------
If you already have **pip** on your system, installing **pathod** and its
dependencies is dead simple:
pip install pathod
The project has the following dependencies:
* netlib_
* requests_
The project's test suite uses the nose_ unit testing framework.
.. _netlib: https://github.com/mitmproxy/netlib
.. _requests: http://docs.python-requests.org/en/latest/index.html
.. _nose: http://nose.readthedocs.org/en/latest/

2
pathod/setup.py
View File

@ -11,7 +11,7 @@ here = os.path.abspath(os.path.dirname(__file__))
sys.path.append(os.path.join(here, "..", "netlib"))
from libpathod import version
with open(os.path.join(here, 'README.txt'), encoding='utf-8') as f:
with open(os.path.join(here, 'README.rst'), encoding='utf-8') as f:
long_description = f.read()
setup(