Skip to main content

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)
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.

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

mail@radeksprta.eu

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

Metadata

Release files for Cachalot 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for Cachalot 0.1.1
File Size Uploaded Provenance
cachalot-0.1.1.tar.gz 7.4 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for Cachalot 0.1.1
File Interpreter ABI Platform
cachalot-0.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 13.4 kB

Release files / cachalot-0.1.1.tar.gz

Download URL cachalot-0.1.1.tar.gz
Size 7.4 kB
Tags Source
SHA-256 checksum
How to use checksums
86fb0f815c75ced189a276a2f2428cd783e8f0a287fe116247e0ad88a7f43a6b
BLAKE2b-256 checksum
How to use checksums
b0d51b78fda85ec986c921b26d6e1c6764229c6c26e03dee337ebdd2861b5485
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / cachalot-0.1.1-py3-none-any.whl

Download URL cachalot-0.1.1-py3-none-any.whl
Size 6.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
af9ab5bf479307e17421cd43faa401c5442f5d360185b3c7be964454ebc67a8f
BLAKE2b-256 checksum
How to use checksums
7689939f5fa0c5c8e57a042e5c87717ef62fe802a359d8ec8e9fb9927a76b0ef
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for Cachalot 0.1.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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page