Metadata-Version: 2.4
Name: def-cache
Version: 1.0.0
Summary: def-cache is a python package used to cache results from python methods
Author-Email: Mihalis Papakonstantinou <mihalispapak@gmail.com>
License-File: LICENSE
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python
Classifier: Topic :: Internet
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development
Classifier: Typing :: Typed
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Project-URL: Homepage, https://github.com/mihalispap/method-cache
Project-URL: Issues, https://github.com/mihalispap/method-cache/issues
Requires-Python: >=3.8
Description-Content-Type: text/markdown

## def-cache

`def-cache` is a python package that can be used as a method decorator to case their results.

Currently, the backend supported is `fs` (file-system) and the results of the cached method are stored in files

### Installation

As `def-cache` is a python package it can be installed directly using pip:
```bash
python -m pip install def-cache
```

Alternatively one can use the source code directly.

### Usage

Upon installation one can directly use the decorator on the methods that need to be cached.

TODO: add code snippets