diff options
Diffstat (limited to 'pathod')
| -rw-r--r-- | pathod/README.mkd | 44 | ||||
| -rw-r--r-- | pathod/README.rst | 60 | ||||
| -rw-r--r-- | pathod/README.txt | 43 | ||||
| -rw-r--r-- | pathod/setup.py | 2 |
4 files changed, 61 insertions, 88 deletions
diff --git a/pathod/README.mkd b/pathod/README.mkd deleted file mode 100644 index 9f8c487b..00000000 --- a/pathod/README.mkd +++ /dev/null @@ -1,44 +0,0 @@ -[](https://travis-ci.org/mitmproxy/pathod) -[](https://landscape.io/github/mitmproxy/pathod/master) -[](https://coveralls.io/r/mitmproxy/pathod) -[](https://pypi.python.org/pypi/pathod) -[](https://pypi.python.org/pypi/pathod) -[](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. diff --git a/pathod/README.rst b/pathod/README.rst new file mode 100644 index 00000000..5593e053 --- /dev/null +++ b/pathod/README.rst @@ -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
\ No newline at end of file diff --git a/pathod/README.txt b/pathod/README.txt deleted file mode 100644 index f8fbdac5..00000000 --- a/pathod/README.txt +++ /dev/null @@ -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/ diff --git a/pathod/setup.py b/pathod/setup.py index 3972d8ff..ba329eda 100644 --- a/pathod/setup.py +++ b/pathod/setup.py @@ -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( |