Skip to content

LangCards is a command-line tool for generating flashcards from a list of words and translations.

License

Notifications You must be signed in to change notification settings

Priyanshu085/LangCard

Repository files navigation

LangCard

LangCards is a command-line tool for generating flashcards from a list of words and translations.

Table of Contents

Usage

  1. Install the required dependencies:
pip install -r requirements.txt
  1. Run the script with the desired command-line arguments:
python flashcard_generator.py input_files/words.csv --output_file flashcards.pdf --font_size 12
  • input_files/words.csv: Path to the input file containing words and translations.
  • flashcards.pdf: Path to the output PDF file.
  • 12: Font size for the flashcards.

Command-Line Interface

The command-line interface supports the following arguments:

  • Input File (input_file): Path to the input file containing words and translations.
  • Output File (output_file): Path to the output PDF file (default: flashcards.pdf).
  • Font Size (font_size): Font size for the flashcards (default: 12).
  • Layout (layout): Layout for the flashcards, either "Classic", "Boxes", or "Subdiv" (default: Classic).
  • Color (color): Color for text in the flashcards, in the HEX format provided as a string (with brackets) (default: #000000).

Example:

python flashcard_generator.py input_files/test.csv --output_file flashcards.pdf --font_size 12

Contributing

Contributions are welcome! If you'd like to contribute to the project, please follow the guidelines in CONTRIBUTING.md.

License

This project is licensed under the MIT License.

About

LangCards is a command-line tool for generating flashcards from a list of words and translations.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Languages