Metadata-Version: 2.2
Name: httpcache
Version: 0.1.3
Summary: Simple HTTP cache for Python Requests
Home-page: http://httpcache.readthedocs.org/en/latest/
Author: Cory Benfield
Author-email: cory@lukasa.co.uk
License:    Copyright 2013 Cory Benfield
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this work except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
        
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
License-File: LICENSE
Requires-Dist: requests>=1.2.0
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: license
Dynamic: requires-dist
Dynamic: summary

httpcache: HTTP Caching for Python
===================================

HTTP, like all well designed standards, has multiple confusing mechanisms for
caching. httpcache is a HTTP cache that knows how to use HTTP headers and
status codes to correctly cache your HTTP traffic. It's built for use with the
excellent `Requests <https://github.com/kennethreitz/requests>`_ library,
because if you're not using Requests you're probably prepared to roll your own
caching library too.

It's gloriously easy to use. If all you want is caching in Requests, all you
need to do is plug a transport adapter into your Requests session:

.. code-block:: pycon

    >>> import requests
    >>> from httpcache import CachingHTTPAdapter
    >>> s = requests.Session()
    >>> s.mount('http://', CachingHTTPAdapter())

Away you go!

If you want more control, you can use the cache data-store itself. Store your
cache entries like this:

.. code-block:: python

    from httpcache import HTTPCache
    cache = HTTPCache(capacity=50)
    cache.store(response)

And retrieve them like this:

.. code-block:: python

    cached_response = cache.retrieve(request)

Simple.

Features
--------

- Tight integration with `Requests <https://github.com/kennethreitz/requests>`_
  data structures.
- Understands ``Expires`` and ``Cache-Control`` headers.
- Knows how to interpret ``304 Not Modified`` responses.
- Can send ``If-Modified-Since`` headers.
- Aware of HTTP verbs, e.g. ``POST``.
- RFC 2616-compliant.

Installation
------------

To install httpcache, you want to run:

.. code-block:: bash

    $ pip install httpcache

If you can't do that, and you really must have httpcache, and you can't
install ``pip``, then you can try:

.. code-block:: bash

    $ easy_install httpcache

I strongly recommend you don't do that though.

Versions
--------

httpcache supports all the versions of Python that Requests does. This means
2.6, 2.7 and 3.3. It is possible that httpcache will work on other versions of
Python but we do not test on those versions and will not support them.

Contribute
----------

Contributions are always welcome! Please abide by the following rules when
contributing:

#. Check that no-one has opened an issue already covering your bug. If you open
   a duplicate issue, the maintainer will give you a stern look.
#. Fork the `Github repository`_ and start writing your tests. If you're fixing
   a bug, I recommend writing a failing test first and working until it passes.
   If you're adding a feature, you're free to add tests after you write the
   functionality, but please test the functionality thoroughly.
#. Send a Pull Request. If I don't respond within a couple of days, please
   shout at me on Twitter or via email until I do something about it.

.. _`Github repository`: https://github.com/Lukasa/httpcache


History
-------

0.1.3 (2013-05-19)
++++++++++++++++++

* Support Python 2.6
* Support Python 3.3

0.1.2 (2013-05-18)
++++++++++++++++++

* Fix broken setup.py.

0.1.1 (2013-05-18)
++++++++++++++++++

* Cache a broader set of response codes.
* Follow RFC 2616's recommendations about caching resources with query strings.
* Don't cache non-idempotent methods.
* Non-idempotent methods invalidate their cache resources.
* Documentation!
* Actually implement the capacity parameter.

0.1.0 (2013-05-11)
++++++++++++++++++

* Provide a Requests Transport Adapter so that caching 'Just Works'.

0.0.2 (2013-05-07)
++++++++++++++++++

* Correctly cache using the 'Expires' header.
* Correctly handle some of the functionality exposed by the 'Cache-Control' header.

0.0.1 (2013-05-05)
++++++++++++++++++

* Conception
* If-Modified-Since and 304 handling.
