summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJoe Gregorio <joe@bitworking.org>2013-10-12 21:39:30 -0400
committerJoe Gregorio <joe@bitworking.org>2013-10-12 21:39:30 -0400
commit09d237e2782d6b5462f9989acda96ab75b48789b (patch)
tree6447a32360bca1ad53cf5a18495ada6c22cec714 /README.md
parent01c687f847ec51ad9c0948905c23060ac605f0d8 (diff)
downloadhttplib2-09d237e2782d6b5462f9989acda96ab75b48789b.tar.gz
Last fixed for markdown.
Diffstat (limited to 'README.md')
-rw-r--r--README.md52
1 files changed, 25 insertions, 27 deletions
diff --git a/README.md b/README.md
index d1bb8ff..7bf7cf2 100644
--- a/README.md
+++ b/README.md
@@ -1,54 +1,48 @@
-###Httplib2
-
-
Introduction
============
-A comprehensive HTTP client library, httplib2.py supports many
+httplib2 is a comprehensive HTTP client library, httplib2.py supports many
features left out of other HTTP libraries.
###HTTP and HTTPS
- HTTPS support is only available if the socket module was
- compiled with SSL support.
+HTTPS support is only available if the socket module was
+compiled with SSL support.
+
###Keep-Alive
- Supports HTTP 1.1 Keep-Alive, keeping the socket open and
- performing multiple requests over the same connection if
- possible.
+Supports HTTP 1.1 Keep-Alive, keeping the socket open and
+performing multiple requests over the same connection if
+possible.
+
###Authentication
- The following three types of HTTP Authentication are
- supported. These can be used over both HTTP and HTTPS.
+The following three types of HTTP Authentication are
+supported. These can be used over both HTTP and HTTPS.
* Digest
* Basic
* WSSE
###Caching
- The module can optionally operate with a private cache that
- understands the Cache-Control: header and uses both the ETag
- and Last-Modified cache validators.
+The module can optionally operate with a private cache that
+understands the Cache-Control: header and uses both the ETag
+and Last-Modified cache validators.
###All Methods
- The module can handle any HTTP request method, not just GET
- and POST.
+The module can handle any HTTP request method, not just GET
+and POST.
###Redirects
- Automatically follows 3XX redirects on GETs.
+Automatically follows 3XX redirects on GETs.
###Compression
- Handles both 'deflate' and 'gzip' types of compression.
+Handles both 'deflate' and 'gzip' types of compression.
###Lost update support
- Automatically adds back ETags into PUT requests to resources
- we have already cached. This implements Section 3.2 of
- Detecting the Lost Update Problem Using Unreserved Checkout.
+Automatically adds back ETags into PUT requests to resources
+we have already cached. This implements Section 3.2 of
+Detecting the Lost Update Problem Using Unreserved Checkout.
###Unit Tested
- A large and growing set of unit tests.
-
-
-For more information on this module, see:
-
- http://bitworking.org/projects/httplib2/
+A large and growing set of unit tests.
Installation
@@ -75,21 +69,25 @@ is already decompressed or unzipped if necessary.
To PUT some content to a server that uses SSL and Basic authentication:
+```python
import httplib2
h = httplib2.Http(".cache")
h.add_credentials('name', 'password')
(resp, content) = h.request("https://example.org/chapter/2",
"PUT", body="This is text",
headers={'content-type':'text/plain'} )
+```
Use the Cache-Control: header to control how the caching operates.
+```python
import httplib2
h = httplib2.Http(".cache")
(resp, content) = h.request("http://bitworking.org/", "GET")
...
(resp, content) = h.request("http://bitworking.org/", "GET",
headers={'cache-control':'no-cache'})
+```
The first request will be cached and since this is a request
to bitworking.org it will be set to be cached for two hours,