French Vocabulary LaTeX Builder

Table of Contents

1. Introduction
2. Prerequisites
3. Installation
4. Configuration
5. Usage
6. Features
7. Troubleshooting

Introduction

The French Vocabulary LaTeX Builder is a Python application designed to help users create and maintain a LaTeX document for French vocabulary. It leverages AI-powered assistance to generate definitions and examples for French words, formatting them into LaTeX entries and inserting them into a specified file. Additionally, the tool offers seamless export to Anki decks for efficient learning.

Prerequisites

Before you begin, ensure you have the following installed:

• Python 3.7 or higher
• pip (Python package installer)
• An Anthropic API key for Claude AI integration

Setting Up the Anthropic API Key

You need to set your Anthropic API key as an environment variable. Follow the instructions for your operating system:

macOS

1. Open the Terminal.

2. Run the following command, replacing your-api-key-here with your actual API key:

   export ANTHROPIC_API_KEY='your-api-key-here'

3. To make this change permanent, follow these steps:

   a. Open your shell configuration file using nano. Depending on your shell, run one of these commands:

   • For Bash: nano ~/.bash_profile or nano ~/.bashrc
   • For Zsh: nano ~/.zshrc

   b. Add the following line to the end of the file:

   export ANTHROPIC_API_KEY='your-api-key-here'

   Replace 'your-api-key-here' with your actual Anthropic API key.

   c. Save the file and exit nano:

   • Press Ctrl + X
   • Press Y to confirm saving
   • Press Enter to keep the same filename

   d. To apply the changes immediately, run the following command in your terminal:

   source ~/.zshrc  # If using Zsh

   or

   source ~/.bash_profile  # If using Bash

   This will make the API key available in all new terminal sessions.

Windows

1. Open Command Prompt or PowerShell.

2. Run the following command, replacing your-api-key-here with your actual API key:

   setx ANTHROPIC_API_KEY "your-api-key-here"

3. Restart your Command Prompt or PowerShell to apply the changes.

Installation

1. Clone the repository or download the source code:

   git clone https://github.com/Razeberry/frenchvocab.git
   cd frenchvocab

2. Install the required Python packages:

   pip install -r requirements.txt

Configuration

The French Vocabulary LaTeX Builder includes automatic setup and configuration:

1. First-time Setup:

   • On the first run, if the ANTHROPIC_API_KEY is not set in the environment variables, the program will attempt to retrieve it from the system's secure keyring.
   • If the API key is not found in the keyring, the program will guide you through the process of obtaining and entering a valid Anthropic API key.
   • The API key will be securely stored in the system's keyring for future use.
   • The program will validate the API key before proceeding.

2. Automatic LaTeX File Generation:

   • If the LaTeX file doesn't exist, the program will automatically create it with the necessary structure.
   • The default filename is FrenchVocab.tex in the current working directory.

No manual configuration is required for basic usage. The program will guide you through the setup process on its first run.

Usage

To run the French Vocabulary LaTeX Builder:

1. Open a terminal and navigate to the project directory.

2. Run the script:

   python FrenchVocab.py

3. Follow the on-screen prompts to add new words, search existing entries, export to Anki decks, or exit the program.

Features

1. Add a New Word

• Enter a French word or short expression.
• The AI will provide:
  • Word type
  • English definitions
  • Example sentences in French with English translations
• The information is formatted into a LaTeX entry and inserted into your file.

2. Automatic Alphabetization

• Entries are automatically sorted alphabetically in the LaTeX file.

3. Duplicate Handling

• The system checks for duplicates and offers options to skip, view, or force add the entry.

4. AI-Powered Assistance

• Utilizes Claude AI to generate accurate definitions and contextual examples.

5. Export to Anki Decks

• Export your vocabulary list to Anki decks for efficient learning and review.
• Steps to Export:
  1. Select the option to export to Anki from the main menu.
  2. Enter a name for your Anki deck when prompted.
  3. The program will generate an .apkg file with your vocabulary entries.
  4. The .apkg file can be imported directly into Anki.

Troubleshooting

• API Key Issues: Ensure your Anthropic API key is correctly set as an environment variable.
• File Not Found Error: Double-check the path to your LaTeX file in the main() function.
• Unicode Errors: Make sure your terminal supports UTF-8 encoding for proper display of French characters.
• Anki Export Errors: Ensure that the LaTeX file exists and contains valid entries before attempting to export.

For additional help, refer to the GitHub Issues page.

---