Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ diskcache-community forked from DiskCache at upstream commit ebfa37c (3 March 20

### Docs

- A new benchmarks page, measured on 2026-10-12, compares diskcache-community with diskcache 5.6.3, memcached, Redis, lmdb, sqlitedict, shelve and the Django cache backends, with four charts. The scripts that produce it are in `tests/benchmarks` (`driver.py` runs the stores, `report.py` writes the page and charts from the JSON results). The 2019 pages from upstream stay as the old benchmarks, labelled as such and linked from the new page, and the README header, features and documentation list link to the new page (PR #26).
- Shared links show a project card: a social preview image in `.github/`, and Open Graph tags on the documentation through `sphinxext-opengraph` (PR #21).
- A logo: the README opens with a centered header (logo, name, tagline, links, badges) in the style of the other community forks, and the documentation shows the logo and a favicon (PR #20).
- The README is rewritten in Markdown around install, usage and the fork story; the comparison tables move to a new `comparisons` page in the documentation, which gets its own landing page, and the 2016 testimonials are dropped (PR #19).
Expand Down
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
<h4><p align="center">
<a href="https://diskcache-community.readthedocs.io/en/latest/tutorial.html">[Tutorial]</a>
- <a href="https://diskcache-community.readthedocs.io/en/latest/api.html">[API]</a>
- <a href="https://diskcache-community.readthedocs.io/en/latest/benchmarks.html">[Benchmarks]</a>
- <a href="https://diskcache-community.readthedocs.io/en/latest/">[Docs]</a>
- <a href="https://github.com/secondwindoss/diskcache-community/blob/master/CHANGELOG.md">[Changelog]</a>
</p></h4>
Expand Down Expand Up @@ -108,9 +109,11 @@ cache = Cache('cache', disk=SafeDisk)
- Read-only mode, automatic when the directory is not writable
- Opt-in `SafeDisk` for caches whose directory other users can write to
- Pure Python on top of the standard library `sqlite3`; no server, no compiler
- Tested on CPython 3.10 to 3.14 on Linux, macOS and Windows, with
[benchmarks](https://diskcache-community.readthedocs.io/en/latest/cache-benchmarks.html)
against the alternatives
- Tested on CPython 3.10 to 3.14 on Linux, macOS and Windows
- Gets in about 2.6 µs and sets in about 19 µs on an Apple M5 Pro in the
[benchmarks](https://diskcache-community.readthedocs.io/en/latest/benchmarks.html)
against memcached, Redis, lmdb, sqlitedict and shelve; sets are 9 to 14 %
faster than in diskcache 5.6.3, and twice as fast for 1 MB values

## Why this fork

Expand Down Expand Up @@ -171,8 +174,12 @@ The documentation is at

- [Tutorial](https://diskcache-community.readthedocs.io/en/latest/tutorial.html)
- [API reference](https://diskcache-community.readthedocs.io/en/latest/api.html)
- [Cache benchmarks](https://diskcache-community.readthedocs.io/en/latest/cache-benchmarks.html)
and [DjangoCache benchmarks](https://diskcache-community.readthedocs.io/en/latest/djangocache-benchmarks.html)
- [Benchmarks](https://diskcache-community.readthedocs.io/en/latest/benchmarks.html)
against memcached, Redis, lmdb, sqlitedict and shelve, the Django cache
backends, and diskcache 5.6.3 (measured 2026-10-12)
- Old benchmarks from 2019, measured by upstream for version 4:
[Cache](https://diskcache-community.readthedocs.io/en/latest/cache-benchmarks.html)
and [DjangoCache](https://diskcache-community.readthedocs.io/en/latest/djangocache-benchmarks.html)
- [Comparisons](https://diskcache-community.readthedocs.io/en/latest/comparisons.html)
with other key-value stores and caching libraries
- Case studies:
Expand Down
Binary file added docs/_static/benchmarks/bench-classic.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/benchmarks/bench-django.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/benchmarks/bench-sizes.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/benchmarks/bench-throughput.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading