blob: 54a242a28b41b15bcc1cbfab66acba99673da131 [file] [log] [blame]
<!DOCTYPE html>
<html>
<head>
<meta charset='utf-8' />
<meta http-equiv="X-UA-Compatible" content="chrome=1" />
<meta name="description" content="Httplib2 : A comprehensive HTTP client library for Python" />
<link rel="stylesheet" type="text/css" media="screen" href="stylesheets/stylesheet.css">
<title>Httplib2</title>
</head>
<body>
<!-- HEADER -->
<div id="header_wrap" class="outer">
<header class="inner">
<a id="forkme_banner" href="https://github.com/jcgregorio/httplib2">View on GitHub</a>
<h1 id="project_title">Httplib2</h1>
<h2 id="project_tagline">A comprehensive HTTP client library for Python</h2>
<section id="downloads">
<a class="zip_download_link" href="https://github.com/jcgregorio/httplib2/zipball/master">Download this project as a .zip file</a>
<a class="tar_download_link" href="https://github.com/jcgregorio/httplib2/tarball/master">Download this project as a tar.gz file</a>
</section>
</header>
</div>
<!-- MAIN CONTENT -->
<div id="main_content_wrap" class="outer">
<section id="main_content" class="inner">
<h3>
<a name="welcome-to-github-pages" class="anchor" href="#welcome-to-github-pages"><span class="octicon octicon-link"></span></a>Welcome to GitHub Pages.</h3>
<p>This automatic page generator is the easiest way to create beautiful pages for all of your projects. Author your page content here using GitHub Flavored Markdown, select a template crafted by a designer, and publish. After your page is generated, you can check out the new branch:</p>
<pre><code>$ cd your_repo_root/repo_name
$ git fetch origin
$ git checkout gh-pages
</code></pre>
<p>If you're using the GitHub for Mac, simply sync your repository and you'll see the new branch.</p>
<h3>
<a name="designer-templates" class="anchor" href="#designer-templates"><span class="octicon octicon-link"></span></a>Designer Templates</h3>
<p>We've crafted some handsome templates for you to use. Go ahead and continue to layouts to browse through them. You can easily go back to edit your page before publishing. After publishing your page, you can revisit the page generator and switch to another theme. Your Page content will be preserved if it remained markdown format.</p>
<h3>
<a name="rather-drive-stick" class="anchor" href="#rather-drive-stick"><span class="octicon octicon-link"></span></a>Rather Drive Stick?</h3>
<p>If you prefer to not use the automatic generator, push a branch named <code>gh-pages</code> to your repository to create a page manually. In addition to supporting regular HTML content, GitHub Pages support Jekyll, a simple, blog aware static site generator written by our own Tom Preston-Werner. Jekyll makes it easy to create site-wide headers and footers without having to copy them across every page. It also offers intelligent blog support and other advanced templating features.</p>
<h3>
<a name="authors-and-contributors" class="anchor" href="#authors-and-contributors"><span class="octicon octicon-link"></span></a>Authors and Contributors</h3>
<p>You can <a href="https://github.com/blog/821" class="user-mention">@mention</a> a GitHub username to generate a link to their profile. The resulting <code>&lt;a&gt;</code> element will link to the contributor's GitHub Profile. For example: In 2007, Chris Wanstrath (<a href="https://github.com/defunkt" class="user-mention">@defunkt</a>), PJ Hyett (<a href="https://github.com/pjhyett" class="user-mention">@pjhyett</a>), and Tom Preston-Werner (<a href="https://github.com/mojombo" class="user-mention">@mojombo</a>) founded GitHub.</p>
<h3>
<a name="support-or-contact" class="anchor" href="#support-or-contact"><span class="octicon octicon-link"></span></a>Support or Contact</h3>
<p>Having trouble with Pages? Check out the documentation at <a href="http://help.github.com/pages">http://help.github.com/pages</a> or contact <a href="mailto:support@github.com">support@github.com</a> and we’ll help you sort it out.</p>
<h3>
<a name="httplib2" class="anchor" href="#httplib2"><span class="octicon octicon-link"></span></a>Httplib2</h3>
<p>A comprehensive HTTP client library that supports many features left out of other HTTP libraries.</p>
<h3>
<a name="requirements" class="anchor" href="#requirements"><span class="octicon octicon-link"></span></a>Requirements</h3>
<p>Requires Python 2.3 or later. Version 0.5.0 and later includes Python 3 support.</p>
<h3>
<a name="documentation" class="anchor" href="#documentation"><span class="octicon octicon-link"></span></a>Documentation</h3>
<p>There is New Python library style documentation and more detailed Examples and ExamplesPython3 for how to use httplib2 in specific situations.</p>
<p>There are also two articles about httplib2 on XML.com, Doing HTTP Caching Right: Introducing httplib2 and httplib2: HTTP Persistence and Authentication.</p>
<h2>
<a name="downloadinstallation" class="anchor" href="#downloadinstallation"><span class="octicon octicon-link"></span></a>Download/Installation</h2>
<p>Httplib2 is a standard distutils package. See the downloading and installation instructions.</p>
<h2>
<a name="features" class="anchor" href="#features"><span class="octicon octicon-link"></span></a>Features</h2>
<p>HTTP and HTTPS</p>
<p>HTTPS support is only available if the socket module was compiled with SSL support.</p>
<h2>
<a name="keep-alive" class="anchor" href="#keep-alive"><span class="octicon octicon-link"></span></a>Keep-Alive</h2>
<p>Supports HTTP 1.1 Keep-Alive, keeping the socket open and performing multiple requests over the same connection if possible.
Authentication</p>
<p>The following types of HTTP Authentication are supported. These can be used over both HTTP and HTTPS.</p>
<ul>
<li>Digest</li>
<li>Basic</li>
<li>WSSE</li>
<li>HMAC Digest</li>
<li>Google Account Authentication</li>
<li>Caching</li>
</ul><p>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</p>
<p>The module can handle any HTTP request method, not just GET and POST.</p>
<h2>
<a name="redirects" class="anchor" href="#redirects"><span class="octicon octicon-link"></span></a>Redirects</h2>
<p>Automatically follows 3XX redirects on GETs.</p>
<h2>
<a name="compression" class="anchor" href="#compression"><span class="octicon octicon-link"></span></a>Compression</h2>
<p>Handles both 'deflate' and 'gzip' types of compression.</p>
<h2>
<a name="lost-update-support" class="anchor" href="#lost-update-support"><span class="octicon octicon-link"></span></a>Lost update support</h2>
<p>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.</p>
<h2>
<a name="unit-tested" class="anchor" href="#unit-tested"><span class="octicon octicon-link"></span></a>Unit Tested</h2>
<p>A large and growing set of unit tests.
Project Goal
To become a worthy addition to the standard Python library.</p>
<h2>
<a name="contributing" class="anchor" href="#contributing"><span class="octicon octicon-link"></span></a>Contributing</h2>
<p>Please submit patches for review using <a href="http://codereview.appspot.com">http://codereview.appspot.com</a>, and make sure to include <a href="mailto:httplib2-dev@googlegroups.com">httplib2-dev@googlegroups.com</a> on the CC list. More details on the Contributor wiki page.</p>
<p>Contributors
Thomas Broyer (<a href="mailto:t.broyer@ltgt.net">t.broyer@ltgt.net</a>)
James Antill
Xavier Verges Farrero
Jonathan Feinberg
Blair Zajac
Sam Ruby
Louis Nyffenegger
Corey Goldberg
Mark Pilgrim
(Your Name Here)</p>
</section>
</div>
<!-- FOOTER -->
<div id="footer_wrap" class="outer">
<footer class="inner">
<p class="copyright">Httplib2 maintained by <a href="https://github.com/jcgregorio">jcgregorio</a></p>
<p>Published with <a href="http://pages.github.com">GitHub Pages</a></p>
</footer>
</div>
</body>
</html>