Skip to main content
Help the Python Software Foundation raise $60,000 USD by December 31st!  Building the PSF Q4 Fundraiser

Converts physical flashcards to digital anki flashcards

Project description

anki_ocr

anki_ocr is a python program that converts physical flashcards into digital Anki(Anki is a flashcard program that sychronizes your flashcards and uses spaced repetition for efficient memorization) decks. It uses PyTesseract and genanki to turn your handwritten flashcards into digital anki ones.

There are several use cases, mainly its for you if you have a lot of flashcards and and want to digitize them. Anki does support image flashcards, but it would take a lot of time and you wouldn't be able to search the flashcards. Its also useful if you're not allowed to use a laptop/phone in class or prefer to handwrite your notes.

Installation

Use the package manager pip to install anki_ocr.

pip install anki_ocr

Usage

To use anki_ocr, you will need a directory with images of your flashcards. The program will automatically sort the images by date, so you should capture the question followed by its answer(i.e question1>answer1>question2>answer2 and so on), and ensure the number of images is even

anki_ocr [img_directory] [output_deck_name]

This will output an Anki deck package output_deck_name.apkg. This package can be imported into the Desktop or mobile Anki apps

Contributing

This project is beginner friendly. The entire module is a small single file, and the only new package you might have to deal with is genanki just to see some other ways to generate notes.

Clone the project & you probably want a virtual environment

git clone https://github.com/madelesi/anki_ocr.git
cd anki_ocr
python3 -m venv venv_anki_ocr
source venv_anki_ocr/bin/activate

Then install an editable version (updates after every save)

pip install -e .

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

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 anki-ocr, version 0.3.1
Filename, size File type Python version Upload date Hashes
Filename, size anki_ocr-0.3.1-py3-none-any.whl (5.9 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size anki_ocr-0.3.1.tar.gz (4.5 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page