diff options
Diffstat (limited to 'pathod/README.txt')
-rw-r--r-- | pathod/README.txt | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/pathod/README.txt b/pathod/README.txt new file mode 100644 index 00000000..f8fbdac5 --- /dev/null +++ b/pathod/README.txt @@ -0,0 +1,43 @@ +**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/ |