https://github.com/yyyasin19/autocards

automatically create anki flashcards using LLMs
https://github.com/yyyasin19/autocards

Last synced: 20 days ago
JSON representation

automatically create anki flashcards using LLMs

• Host: GitHub
• URL: https://github.com/yyyasin19/autocards
• Owner: YYYasin19
• License: mit
• Created: 2024-06-16T16:27:17.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-06-16T16:29:41.000Z (6 months ago)
• Last Synced: 2024-10-16T16:48:22.070Z (2 months ago)
• Language: Python
• Size: 4.34 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# autocards



[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

[![Pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/YYYasin/autocards/blob/master/.pre-commit-config.yaml)

![Coverage Report](assets/images/coverage.svg)

Automatically generate flashcards from text files and PDFs using LLMs.



## Installation

Install using `pixi`:

```bash

pixi install

pixi run postinstall

```

## Usage

The CLI is very bare-bones right now. It only supports generating flashcards from a single file.

```bash

autocards --help

Usage: autocards [OPTIONS] [DECK_NAME] [SOURCE_PATH] [OUTPUT_PATH]

Options:

  --page-range TEXT

  --num-questions INTEGER

  --help                   Show this message and exit.

```

An example command for the `example/example.pdf` would be

```bash

autocards my-deck example/example.pdf example.apkg --page-range '1-10' --num-questions 20

```

This creates a file called `deck_name.apkg` in the current directory.