Skip to content
Anki add-on to help you keep track of your review activity
Python JavaScript CSS
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Tweak docs Jun 1, 2019
designer Add debug label to options Aug 13, 2019
docs Update to new repo structure May 31, 2019
resources Update copyright year Aug 10, 2019
screenshots Added CHANGELOG and 0.7.0 screenshots Oct 28, 2018
src Update libaddon Aug 13, 2019
.gitattributes Update to new repo structure May 31, 2019
.gitignore
CHANGELOG.md Clarify download instructions May 31, 2019
CONTRIBUTING.md Fix typo Aug 9, 2019
LICENSE Update to new repo structure May 31, 2019
README.md Fix paragraph Jul 22, 2019
addon.json Update to new repo structure May 31, 2019
requirements.txt Add dev requirements Jun 2, 2019

README.md

Review Heatmap for Anki


Your learning performance at a glance

Adds a heatmap graph to Anki's main window which visualizes past and future card review activity, similar to the contribution view on GitHub. Information on the current streak is displayed alongside the heatmap. Clicking on an item shows the cards reviewed on that day.

Video Demonstration

General Overview Customization
YouTube: Anki add-on: Review Heatmap YouTube: Add-on Update: Review Heatmap

(Make sure to enable closed-captions for comments on the demonstrated features)

Installation

AnkiWeb

The easiest way to install Review Heatmap is through AnkiWeb.

Manual installation

Please click on the entry corresponding to your Anki version:

Anki 2.1
  1. Make sure you have the latest version of Anki 2.1 installed. Earlier releases (e.g. found in various Linux distros) do not support .ankiaddon packages.
  2. Download the latest .ankiaddon package from the releases tab (you might need to click on Assets below the description to reveal the download links)
  3. From Anki's main window, head to ToolsAdd-ons
  4. Drag-and-drop the .ankiaddon package onto the add-ons list
  5. Restart Anki

Video summary:

Anki 2.0
  1. Go to ToolsAdd-onsOpen add-ons folder
  2. Find and delete the Review Heatmap.py file if it already exists.
  3. See if you can find a review_heatmap folder. If so:
    1. If the folder contains a meta.json file, copy the file to a safe location. This will allow you to preserve your current settings.
    2. Proceed to delete the review_heatmap folder
  4. Download and extract the latest Anki 2.0 add-on release from the releases tab (you might need to click on Assets below the description to reveal the download links)
  5. Move the extracted Review Heatmap.py and review_heatmap into the add-ons folder
  6. Optional: Place the meta.json file back into the directory if you created a copy beforehand.
  7. Restart Anki

Documentation

The use of the add-on is documented in the Wiki section and a series of video tutorials on YouTube. More information may also be found in the AnkiWeb description.

Building

With Anki add-on builder installed:

git clone https://github.com/glutanimate/review-heatmap.git
cd review-heatmap
aab build

For more information on the build process please refer to aab's documentation.

Contributing

Contributions are welcome! Please review the contribution guidelines on how to:

  • Report issues
  • File pull requests
  • Support the project as a non-developer

License and Credits

Review Heatmap is Copyright © 2016-2019 Aristotelis P. (Glutanimate)

Inspired by GitHub's contribution calendar and Forecast graph on Overview page by Steve AW.

Ships with the following javascript libraries:

  • d3.js (v3.5.17), (c) Mike Bostock, BSD license
  • cal-heatmap (v3.6.2), (c) Wan Qi Chen, MIT license

Review Heatmap is free and open-source software. The add-on code that runs within Anki is released under the GNU AGPLv3 license, extended by a number of additional terms. For more information please see the LICENSE file that accompanied this program.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY.


The continued development of this add-on is made possible
thanks to my Patreon and Ko-Fi supporters.
You guys rock ❤️ !
You can’t perform that action at this time.