https://github.com/tsroten/fcache

a dictionary-like, file-based cache module for Python
https://github.com/tsroten/fcache

Last synced: 3 days ago
JSON representation

a dictionary-like, file-based cache module for Python

• Host: GitHub
• URL: https://github.com/tsroten/fcache
• Owner: tsroten
• License: mit
• Created: 2012-12-29T06:00:01.000Z (almost 12 years ago)
• Default Branch: main
• Last Pushed: 2024-02-23T00:38:23.000Z (9 months ago)
• Last Synced: 2024-09-23T15:39:11.015Z (about 2 months ago)
• Language: Python
• Homepage:
• Size: 7.5 MB
• Stars: 21
• Watchers: 5
• Forks: 15
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE.txt
  • Authors: AUTHORS.rst

Awesome Lists containing this project

README

        
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 `_-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

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.