Metadata-Version: 2.1
Name: ai-vocabulary-builder
Version: 0.1.0
Summary: A tool help you build your vocabulary book using AI.
Author: piglei
Author-email: piglei2007@gmail.com
Requires-Python: >=3.7.1,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: click (>=8.0.0,<9.0.0)
Requires-Dist: openai (>=0.27.0,<0.28.0)
Requires-Dist: questionary (>=1.10.0,<2.0.0)
Requires-Dist: rich (>=13.0.0,<14.0.0)
Requires-Dist: tinydb (>=4.7.1,<5.0.0)
Description-Content-Type: text/markdown

# AI Vocabulary Builder

AI Vocabulary Builder（后简称“aivoc”）是一个利用了 AI 技术的智能生词本工具，可以帮你快速构建起自己的生词库，学习起来事半功倍。

学习一门语言，生词本是一个非常重要的工具。一个内容优秀的生词本，至少需要包含：**生词、释义、例句、例句释义**这些内容。但是，手动维护这些内容非常麻烦，因此大部分人都没有自己的生词本。阅读时碰见生词，常常查过词典，转头就忘。

aivoc 尝试着使用 ChatGPT 的能力，将生词本的维护成本降到最低，让每人都可以拥有自己的生词本。

使用 aivoc，每当你读到一句包含了生词的句子时，只要将其原样输入到 aivoc 工具中，便可以获得：

- 整句话的全文翻译
- 由 AI 提取出的生词及释义
- **一个免维护的全自动生词本表格**

<img width="654" alt="image" src="https://user-images.githubusercontent.com/731266/222906122-5fa8d1fa-0f9f-4697-a227-bbcd7edc72fe.png">

↑ 交互式使用界面

<img width="931" alt="image" src="https://user-images.githubusercontent.com/731266/222906216-3ae12bfd-8404-4cc4-b50c-1ff47d8d1e61.png">

↑ 使用 numbers 打开生词库表格（使用 CSV 纯文本格式，方便二次处理）


## 快速开始

使用 pip 来安装本工具：

```console
# 需要 Python 版本 3.7 及以上
$ pip install ai-vocabulary-builder
```

完成后，在环境变量设置好你的 [OpenAI API key](https://platform.openai.com/account/api-keys)：

```console
# 使用你在 OpenAI 官网上申请到的 key 替换该内容
$ export OPENAI_API_KEY='your_api_key'
```

一切就绪，之后执行 `aivoc` 启动工具，进入交互翻译模式。

执行 `aivoc --help` 查看更多帮助。

## TODO

- 支持 [bob-plugin-openai-translator](https://github.com/yetone/bob-plugin-openai-translator) 插件，实现划词自动扩充生词本。

