Cachalot 
Cachalot is a minimal persistent memoization cache. It provides a decorator, that stores function result for future use. Perfect for heavy computations and I/O operation (such as web requests). On backend, it uses TinyDB for storage.
Features
- Simple usage via decorator
- Persistent caching
- Key expiration
- Maximum cache size, to prevent bloat
Installation
Cachalot requires Python 3.5 or newer to run.
Python package
You can easily install Cachalot using pip:
pip3 install cachalot
Manual
Alternatively, to get the latest development version, you can clone this repository and then manually install it:
git clone git@gitlab.com:radek-sprta/cachalot.git
cd cachalot
python3 setup.py install
Usage
from cachalot import Cache
@Cache()
def expensive_function():
return expensive_calculation()
Advanced usage
from cachalot import Cache
@Cache(path='cache.json', timeout=3600, size=5000, retry=True)
def expensive_function():
return expensive_calculation()
path: Path to the database file. Defaults to .cache.json.timeout: How long should the data be cached in seconds. Defaults to 86400 (1 day).size: Maximum number of keys cached. Defaults to 10000.retry: Retry if result is blank. Defaults to False.
For more information, see documentation.
TODO
- Test suite
- Optionally retry if blank data is returned
Contributing
For information on how to contribute to the project, please check the Contributor's Guide
Contact
incoming+radek-sprta/cachalot@gitlab.com
License
MIT License
Credits
This package was created with Cookiecutter and the python-cookiecutter project template. Inspired by Cashier
1 maintainer
Metadata
1 maintainer
Release files for Cachalot 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| cachalot-0.2.0.tar.gz | 8.3 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cachalot-0.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 12.5 kB
Release files / cachalot-0.2.0.tar.gz
| Download URL | cachalot-0.2.0.tar.gz |
|---|---|
| Size | 8.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c0077b2db2881712cb0c06b81d42fd08222e301ca065c74243167019798f6000
|
|
BLAKE2b-256 checksum How to use checksums |
3426f16531f7d77535d68f9519038158ef416e4495c74a5bd30e878fd017f62d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / cachalot-0.2.0-py3-none-any.whl
| Download URL | cachalot-0.2.0-py3-none-any.whl |
|---|---|
| Size | 4.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f93927d05661b1062402fcd04c637425bcfc7355322c461b2b870d3136cff1e4
|
|
BLAKE2b-256 checksum How to use checksums |
8196d1f962789579d14ee9ae0fb6edf1fb25307d1ee068e5f3a24e04e659fc81
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for Cachalot 0.2.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
