VocabMaster 0.2.0

No project description provided

VocabMaster

Master new languages with this CLI tool, designed to help you record vocabulary and create Anki flashcards without the need to manually input translations or example sentences.

Table of Contents

1. Features
2. Installation
   1. Prerequisites
   2. Install via pip
   3. Install via uv (recommended)
   4. OpenAI API key
   5. Shell Completion
3. Usage
   1. Set up a new language pair
   2. Add words to your vocabulary list
   3. Generate an Anki deck from your vocabulary list
   4. For detailed help on each command, run
4. Importing into Anki
5. Licence

Features

• Record vocabulary words with ease
• Automatic translation and usage examples via OpenAI GPT
• Anki integration for seamless language learning
• Supports multiple languages

Installation

Prerequisites

• Python 3.8 or higher
• Compatible with Windows, Linux, and macOS

Install via pip

python3 -m pip install vocabmaster

Install via uv (recommended)

uv tool install vocabmaster

OpenAI API key

Vocabmaster requires an OpenAI API key to function. You can obtain a key by signing up for an account at OpenAI's website.

Once you have your API key, set it as an environment variable:

• On macOS and Linux:

  export OPENAI_API_KEY="your-api-key-here"
  

  To avoid having to type it everyday, you can create a file with the key:

  echo "your-api-key" > ~/.openai-api-key.txt
  

  Note: Remember to replace "your-api-key" with your actual API key.

  And then, you can add this to your shell configuration file (.bashrc, .zshrc, etc.):

  export OPENAI_API_KEY="$(cat ~/.openai-api-key.txt)"
  

• On Windows:

  setx OPENAI_API_KEY your_key
  

Shell Completion

To enable shell completion for bash or zsh, source the completion file (see the completion folder) related to your shell by adding the following line to your .bashrc or .zshrc file:

For bash

source /path/to/vocabmaster/completion/_complete_vocabmaster.bash

For zsh

source /path/to/vocabmaster/completion/_complete_vocabmaster.zsh

Remember to replace /path/to/vocabmaster with the actual path where the completion file is located.

Usage

Set up a new language pair

vocabmaster setup

Add words to your vocabulary list

vocabmaster add la casa

Generate an Anki deck from your vocabulary list

vocabmaster translate

Choose where your files live

vocabmaster config dir ~/Documents/vocabmaster

Vocabulary CSV and Anki decks default to ~/.vocabmaster, but you can relocate them anywhere. The configuration file itself always stays under ~/.config/vocabmaster/config.json, and VocabMaster remembers your storage choice for future runs.

For detailed help on each command, run

vocabmaster <command> --help

Importing into Anki

To import the vocabulary deck into Anki, follow the steps below:

1. Launch Anki.
2. Click on the Import File button. This will open a file picker dialog.
3. In the file picker, locate and select the anki_deck_language1-language2.csv file.
4. Ensure the Existing notes field is set to Update. This will prevent the creation of duplicate cards if the same note already exists in your deck.

Licence

VocabMaster is released under the Apache Licence version 2.

---

https://github.com/sderev/vocabmaster