/file-disk-cache

Extension of the diskcache package to support saving data to different file types.

Primary LanguagePythonMIT LicenseMIT

File Disk Cache

This is an extension of the DiskCache package.

It extends the functionality of the original disk cache package by allowing users to store objects as different file types within the cache.

This might be useful is one interested in keeping a human interpretable file structure within their file cache.

Installation

Install from source

Clone the repository from github and install it from source using poetry.

poetry install

Releasing

The package follows semantic versioning. To create a new versioned release of File Disk Cache:

  1. Update the version in the pyproject file (e.g. for a minor bump update the second number).

  2. Once the change has been merged, switch to the main locally and create a new git tag. (Make sure the tag is annotated) e.g.

git tag -a v1.1.3 -m "release notes here"
  1. Push the tag to GitHub
git push origin --tags

Testing

To test this repository, call:

make test

This action is defined in the Makefile