Welcome to cache3's documentation!
==================================

.. image:: https://img.shields.io/badge/LICENSE-MIT-green
    :target: https://github.com/StKali/cache3/blob/master/LICENSE
.. image:: https://img.shields.io/badge/version-0.4.2-informational
    :target: https://pypi.org/project/cache3
.. image:: https://img.shields.io/badge/python-3.5+-blueviolet
    :target: https://www.python.org

**Cache3** is a MIT licensed  safe and lightweight cache library, written
in pure-Python.

Check out the :doc:`usage <usage>` section for further information, including how to
:ref:`install <installation>` the project.


.. toctree::
   :maxdepth: 2
   :caption: Contents:

.. note::

   This project is under active development.

Contents
--------
.. toctree::
    usage
    api


Feature
=======
- Pure-Python
- Thread-safe and process-safe
- High performance
- 100% test coverage
- Extension friendly
- Supports multiple eviction policies and is easy to scale
- Supports multiple data types
- Compatible with all platforms


TODO
====
- Improve documentation
- Faster serialization protocol


Indices and tables
==================

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