• Word Wizard
  • Features
  • Usage for Windows end-users
  • Cross-Platform Usage
    • Prerequisites
    • Install Required Python Libraries
    • File Structure
    • Run
    • Screenshots
  • How It Works
    • Components
    • API Key Management
  • Troubleshooting
    • Common Issues
    • Debugging
  • License

Word Wizard is a cross-platform application that helps users build their vocabulary by reading engaging stories with highlighted SAT-level words and their meanings. Google Gemini API is used for dynamically creating a new story every time.

• Dynamic Story Generation: Fetch and display stories with highlighted SAT-level vocabulary words and their meanings.
• Settings Management: A built-in settings menu to save and delete the Gemini API key.
• Cross-Platform: Works on Windows, macOS, and Linux.

Windows binary is provided in the Releases tab on Github

1. Download word_wizard.zip from the Releases tab on Github.

2. Unzip and double-click Word Wizard.exe to start the application.
3. The application will ask for the Gemini API key via a settings menu if it is not already set.
4. Use the settings menu to save or delete the Gemini API key as needed.
5. Fetch new stories and build your vocabulary!

• Python 3.7+
• pip (Python package manager)

Following python packages are required:

pip install flask google-generativeai keyring pywebview

or,

pip install -r requirements.txt

WordWizard
├── html/
│   ├── settings.html
│   └── word_wizard.html
├── prompts/
│   └── prompt.txt
├── requirements.txt
├── word_wizard.py
└── README.md

python word_wizard.py

• Story Window

• Settings Window

• word_wizard.py: Starts a Flask server and opens the application in a webview.

• html/word_wizard.html: Main HTML page for displaying stories.

• html/settings.html: Settings page for managing the Gemini API key.

• prompts/prompt.txt: Contains the prompt used by the Gemini API to generate stories.

• Users must provide the application with a Google Gemini API key in order to use WordWizard
• The API key is stored securely on their local computer using keyring.
• Users can save and delete the API key via the settings menu in the application.

• Server not starting: Ensure that Python and all required libraries are installed correctly.
• API key not working: Double-check that the correct API key is entered and saved. Delete the API key in the Settings tab and enter a new one.

• Use console logs in the JavaScript and print statements in the Python code to debug issues.
• Check the terminal or command prompt for any error messages during execution.

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