.. redcache documentation master file, created by
   sphinx-quickstart on Fri Dec 13 16:25:59 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

redis_func_cache
================

.. image:: https://github.com/tanbro/redis_func_cache/actions/workflows/python-package.yml/badge.svg
   :alt: python-package
   :target: https://github.com/tanbro/redis_func_cache/actions/workflows/python-package.yml

.. image:: https://readthedocs.org/projects/redis-func-cache/badge/
   :alt: readthedocs
   :target: https://redis-func-cache.readthedocs.io/

.. image:: https://codecov.io/gh/tanbro/redis_func_cache/graph/badge.svg?token=BgeXJZdPbJ
   :alt: codecov
   :target: https://codecov.io/gh/tanbro/redis_func_cache

.. image:: https://img.shields.io/pypi/v/redis_func_cache.svg
   :alt: PyPI
   :target: https://pypi.org/project/redis_func_cache/

.. rubric::
   A Python library for caching function results in Redis, similar to the caching functionality provided by the standard library's functools.cache.

========== ========= =========
Release    Version   Built at
========== ========= =========
|release|  |version| |today|
========== ========= =========

Contents
--------

.. toctree::
   :caption: Documentation
   :titlesonly:

   README
   CHANGELOG
   CONTRIBUTING
   AUTHORS
   LICENSE

.. toctree::
   :caption: API Reference
   :titlesonly:
   :maxdepth: 3

   apidoc/modules

Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`