Docs, installation instructions.

This commit is contained in:
Aldo Cortesi 2012-04-29 22:08:35 +12:00
parent cd025636fa
commit 8b02ebe2a4
2 changed files with 31 additions and 2 deletions

View File

@ -231,3 +231,12 @@ Supported data types are:
whitespace whitespace
ascii ascii
bytes bytes
# Inastalling
__pathod__ requires Tornado 2.2.1 or later. If you already have __pip__ on your
system, installing __pathod__ and its dependencies is dead simple:
pip install pathod

View File

@ -1,5 +1,25 @@
Pathod is a pathological HTTP/S server, used for testing and stressing **pathod** is a pathological HTTP/S daemon, useful for testing and torturing
unsuspecting client software. HTTP clients. At **pathod**'s heart is a tiny, terse language for crafting HTTP
responses. The simplest way to use **pathod** is to fire up the daemon, and
specify the response behaviour you want using this language in the request URL.
Here's a minimal example:
http://localhost:9999/p/200
Everything after the "/p/" path component is a response specifier - in this
case just a vanilla 200 OK response. See the complete docs to get (much)
fancier. You can also add anchors to the **pathod** server that serve a fixed
response whenever a matching URL is requested:
pathod --anchor "/foo=200"
Here, "/foo" a regex specifying the anchor path, and the part after the "=" is
a response specifier.
**pathod** also has a nifty built-in web interface, which lets you play with
the language by previewing responses, exposes activity logs, online help and
various other goodies. Try it by visiting the server root:
http://localhost:9999