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=5e3, filesize=1e6, retry=True, renew_on_read=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 0 (infinite).size: Maximum number of keys cached. Defaults to 0 (infinite).filesize: Maximum size of database file in bytes. Defaults to 0 (infinite).retry: Retry if result is blank. Defaults to False.renew_on_read: Renew the entry, i.e refresh the entry timestamp on reads. Defaults to True
For more information, see documentation.
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 1.3.1
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-1.3.1.tar.gz | 7.0 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| Cachalot-1.3.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 15.2 kB
Release files / Cachalot-1.3.1.tar.gz
| Download URL | Cachalot-1.3.1.tar.gz |
|---|---|
| Size | 7.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
cd7925553ec59c3c40409226e6a4d7a094a4da00cb05e6a39a19afcf21ccc0f2
|
|
BLAKE2b-256 checksum How to use checksums |
1d409f3e9ec07f47d24e5fce855e1e1d228fe371194acde203a2a76bc9ccd5c7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.9
|
Release files / Cachalot-1.3.1-py3-none-any.whl
| Download URL | Cachalot-1.3.1-py3-none-any.whl |
|---|---|
| Size | 8.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
97af4c0d1056e2f618c877430278ab06f386d7bacb89e4d7d51e963e0bc719aa
|
|
BLAKE2b-256 checksum How to use checksums |
6efa284dd04667e457f3c5d383d0642a0d23949231e1ab5d3fe00962511f5177
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.9
|
Security for Cachalot 1.3.1
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.
