Metadata-Version: 2.1
Name: epubclozer
Version: 1.0.5
Summary: Turn an epub into Anki flashcards
Home-page: https://github.com/nelsontkq/epubclozer
Author: Nelson
Author-email: nelson@truran.dev
Requires-Python: >=3.11,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: beautifulsoup4 (>=4.11.1,<5.0.0)
Requires-Dist: ebooklib (>=0.18,<0.19)
Requires-Dist: genanki (>=0.13.0,<0.14.0)
Requires-Dist: spacy (>=3.4.4,<4.0.0)
Project-URL: Repository, https://github.com/nelsontkq/epubclozer
Description-Content-Type: text/markdown


# Epub Clozer

Turn an epub into Anki cloze flashcards

## Description

This script will take every unique word in an epub and create a anki cloze flashcard using an example found in the book.


## Requirements

Install [python 3.11](https://www.python.org/downloads/)

Install epubclozer

```shell
python -m pip install epubclozer
```

## How to use

Create a cloze for each unique word in epub:

```shell
python -m epubclozer --lang "en" --path "C:/path/to/book.epub"
```

Ignore [stop words](https://en.wikipedia.org/wiki/Stop_word) by adding the `--exclude-stop-words` option. 

Note this will only work effectively in you pass the target language `--lang` as well.

```shell
python -m epubclozer --lang "es" --path "C:/path/to/book.epub" --exclude-stop-words
```

See `epubclozer --help` for all options

Your Anki package will be put in the same location as the epub.

