README.rst

fcache

fcache is a dictionary-like, file-based cache module for Python. It's simple to use, has an optional write buffer, and is Shelf-compatible.

>>> from fcache.cache import FileCache
>>> mycache = FileCache('myapp')
>>> mycache['foo'] = [1, 2, 3, 4, 5]
>>> mycache['foo']
[1, 2, 3, 4, 5]
>>> mycache['bar'] = 'value'
>>> list(mycache)
['foo', 'bar']
>>> del mycache['foo']
>>> mycache['foo']
    ...
    KeyError: 'foo'

with FileCache('myapp') as mycache:
    mycache['foo'] = [1, 2, 3, 4, 5]

Install

To install fcache, use pip:

$ pip install fcache

Documentation

fcache's documentation contains an introduction along with an API overview. For more information on how to get started with fcache, be sure to read the documentation.

Bug/Issues Tracker

fcache uses its GitHub Issues page to track bugs, feature requests, and support questions.

License

fcache is released under the OSI-approved MIT License. See the file LICENSE.txt for more information.