Skip to main content

Load your anki database as a pandas DataFrame with just one line of code!

Project description

Build Status Coveralls Documentation Status Pypi status Gitter License Black

NOTE: THIS PROJECT IS STILL RATHER FRESH. TRY OUT WITH CARE AND GIVE FEEDBACK!

Description

https://raw.githubusercontent.com/klieret/AnkiPandas/master/misc/logo/logo_github.png

Anki is one of the most popular flashcard system for spaced repetition learning, pandas is the most popular python package for data analysis and manipulation. So what could be better than to bring both together?

With AnkiPandas you can use pandas to easily analyze or manipulate your Anki flashcards.

Features:

  • Select: Easily select arbitrary subsets of your cards, notes or reviews using pandas (one of many introductions, official documentation)
  • Visualize: Use pandas’ powerful built in tools or switch to the even more versatile seaborn (statistical analysis) or matplotlib libraries
  • Manipulate: Apply fast bulk operations to the table (e.g. add tags, change decks, set field contents, suspend cards, …) or iterate over the table and perform these manipulations step by step
  • Add: Add new notes and cards
  • Import and Export: Pandas can export to (and import from) csv, MS Excel, HTML, JSON, … (io documentation)

Pros:

  • Easy installation: Install via python package manager (independent of your Anki installation)
  • Simple: Just one line of code to get started
  • Convenient: Bring together information about cards, notes, models, decks and more in just one table!
  • Fully documented: Documentation on readthedocs
  • Well tested: More than 100 unit tests to keep everything in check

Alternatives: If your main goal is to add new cards, models and more, you can also take a look at the genanki project.

Installation

AnkiPandas is available as pypi package and can be installed or upgrade with the python package manager:

pip3 install --user --upgrade ankipandas

For the latest development version you can also work from a cloned version of this repository:

git clone https://github.com/klieret/ankipandas/
cd ankipandas
pip3 install --user --upgrade .

Usage

Starting up is as easy as this:

from ankipandas import Collection

col = Collection()

And col.notes will be dataframe containing all notes, with additional methods that make many things easy. Similarly, you can access cards or reviews using col.cards or col.revs.

If called without any argument Collection() tries to find your Anki database by itself. However this might take some time. To make it easier, simply supply (part of) the path to the database and (if you have more than one user) your Anki user name, e.g. Collection(".local/share/Anki2/", user="User 1") on many Linux installations.

To get information about the interpretation of each column, use notes.help_cols().

Take a look at the documentation to find out more about more about the available methods!

Some basic examples:

Analysis

Show a histogram of the number of reviews (repetitions) of each card for all decks:

col.cards.hist(column="creps", by="cdeck")

Show the number of leeches per deck as pie chart:

cards = col.cards.merge_notes()
selection = cards[cards.has_tag("leech")]
selection["cdeck"].value_counts().plot.pie()

Find all notes of model MnemoticModel with empty Mnemotic field:

notes = col.notes.fields_as_columns()
notes.query("model=='MnemoticModel' and 'Mnemotic'==''")

Manipulations

Add the difficult-japanese and marked tag to all notes that contain the tags Japanese and leech:

selection = col.notes.has_tags(["Japanese", "leech"])
selection = selection.add_tag(["difficult-japanese", "marked"])
col.notes.update(selection)
col.write(modify=True)  # Overwrites your database after creating a backup!

Set the language field to English for all notes of model LanguageModel that are tagged with English:

selection = col.notes.has_tag(["English"]).query("model=='LanguageModel'").fields_as_columns()
selection["language"] = "English"
col.notes.update(selection)
col.write(modify=True)

Move all cards tagged leech to the deck Leeches Only:

selection = col.cards.has_tag("leech")
selection["cdeck"] = "Leeches Only"
col.cards.update(selection)
col.write(modify=True)

Contributing

Your help is greatly appreciated! Suggestions, bug reports and feature requests are best opened as github issues. You could also first discuss in the gitter community. If you want to code something yourself, you are very welcome to submit a pull request!

License & Disclaimer

This software is licenced under the MIT license and (despite best testing efforts) comes without any warranty. The logo is inspired by the Anki logo (license) and the logo of the pandas package (license2). This library and its author(s) are not affiliated/associated with the main Anki or pandas project in any way.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for ankipandas, version 0.3.2
Filename, size File type Python version Upload date Hashes
Filename, size ankipandas-0.3.2-py3-none-any.whl (48.2 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size ankipandas-0.3.2.tar.gz (43.3 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page