Git Product home page Git Product logo

pdf-to-anki's Introduction

Python FAQ Anki Deck Generator

This Python script allows you to generate Anki decks from PDF files containing FAQ-style content. It extracts text from the PDF, formats it into Anki-compatible question-answer pairs, and creates an Anki deck in .apkg format.

Requirements

  • Python 3.x
  • genanki library (install via pip install genanki)
  • pdfminer.six library (install via pip install pdfminer.six)

Usage

  1. Ensure you have Python installed on your system.
  2. Install required dependencies using pip.
  3. Run the script using python main.py <path-to-pdf> --deck_name <deck-name>. 4 The Anki deck will be generated as <deck-name>.apkg in the root directory.

Notes

  • Ensure your PDF file follows a specific format where questions start with a number followed by a dot and answers are listed below each question.
  • Questions and answers are separated by a newline.
  • The script uses pdfminer.six to extract text from the PDF file, so ensure it's properly formatted and readable.
  • HTML tags within questions and answers are escaped to prevent formatting issues in Anki.

License

This project is licensed under the MIT License. See the LICENSE file for details.

pdf-to-anki's People

Contributors

earlhikky avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.