fcache

.. image:: https://badge.fury.io/py/fcache.svg :target: https://pypi.org/project/fcache

.. image:: https://github.com/tsroten/fcache/actions/workflows/ci.yml/badge.svg :target: https://github.com/tsroten/fcache/actions/workflows/ci.yml

fcache is a dictionary-like, file-based cache module for Python. It's simple to use, has an optional write buffer, and is Shelf <http://docs.python.org/3/library/shelve.html#shelve.Shelf>_-compatible.

.. code:: python

>>> 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'

.. code:: python

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

Install

To install fcache, use pip:

.. code:: bash

$ pip install fcache

fcache also requires the appdirs <https://github.com/ActiveState/appdirs>_ package.

Documentation

fcache's documentation <https://tsroten.github.io/fcache/>_ 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 <https://github.com/tsroten/fcache/issues>_ to track bugs, feature requests, and support questions.

License

fcache is released under the OSI-approved MIT License <http://opensource.org/licenses/MIT>_. See the file LICENSE.txt for more information.