Metadata-Version: 2.1
Name: ai-vocabulary-builder
Version: 1.2.1
Summary: A tool help you build your vocabulary book using AI.
Author: piglei
Author-email: piglei2007@gmail.com
Requires-Python: >=3.9,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: cattrs (>=24.1.2,<25.0.0)
Requires-Dist: click (>=8.0.0,<9.0.0)
Requires-Dist: fastapi (>=0.115.6,<0.116.0)
Requires-Dist: packaging (>=23.0,<24.0)
Requires-Dist: pydantic-ai (>=0.0.13,<0.0.14)
Requires-Dist: requests (>=2.32.3,<3.0.0)
Requires-Dist: rich (>=13.0.0,<14.0.0)
Requires-Dist: sse-starlette (>=1.3.4,<2.0.0)
Requires-Dist: tinydb (>=4.7.1,<5.0.0)
Requires-Dist: unearth (>=0.17.2,<0.18.0)
Requires-Dist: uvicorn[standard] (>=0.22.0,<0.23.0)
Description-Content-Type: text/markdown

# AI-Voc Builder

"AI-Voc Builder" is a smart English vocabulary tool powered by AI technology. It helps you quickly build your own English vocabulary and learn more effectively.

Key Features:

- Unique, efficient vocabulary building: **One-click** saving of sample sentences, translations, new words, and definitions.
- Engaging story and test modes to help you master new words.
- Supports over 10 target languages with multiple AI backends, including OpenAI, Gemini, and Anthropic.

Product Screenshots:

<div align="center">
  <table>
    <tr>
      <td align="center">
        <a href="https://github.com/user-attachments/assets/cbf46c1b-e383-46e2-96ce-bbce0098fe11" target="_blank">
          <img src="https://github.com/user-attachments/assets/cbf46c1b-e383-46e2-96ce-bbce0098fe11" style="max-height: 200px;">
        </a>
        <br>↑ AI-Powered Smart Vocabulary Extraction
      </td>
      <td align="center">
        <a href="https://github.com/user-attachments/assets/bdfe9802-bccc-4d85-9fc5-09829a20bbcc" target="_blank">
          <img src="https://github.com/user-attachments/assets/bdfe9802-bccc-4d85-9fc5-09829a20bbcc" style="max-height: 200px;">
        </a>
        <br>↑ Test Mode for Enhanced Memorization
      </td>
    </tr>
  </table>
</div>

## Quick Start

This tool is developed using Python. Please use `pip` to install it:

```console
# Requires Python version 3.9 or higher
pip install ai-vocabulary-builder
```

After installation, run `aivoc notebook` to open the application in your browser.

## Configurations

The main configurations for this tool can be managed from the web page. Here are some additional configurations that are set through environment variables.

### AIVOC_DATA_DIR

Specifies the path where the vocabulary data files are stored. The default path is the current user's home directory: ~/.

Example:

```
export AIVOC_DATA_DIR="$HOME/Documents"
```

## Why Develop This Tool?

When learning English, a vocabulary builder is a very important tool. A good vocabulary builder should include at least the following: **new words, definitions, example sentences, and example sentence translations** . However, maintaining this information manually is very tedious. As a result, most people who have studied English for many years do not have their own vocabulary builder. They often encounter new words while reading, look them up in the dictionary, and then forget them 20 seconds later.

"AI-Voc Builder" tries to use the power of AI to make the process of building a vocabulary builder easy and fun, so that everyone can have their own vocabulary builder and quickly expand their vocabulary.

