Metadata-Version: 2.3
Name: nonebot-plugin-just-enough-katakanas
Version: 0.3.2
Summary: An NoneBot plugin that converts English texts to Katakanas.
Author: p0rt39
Author-email: p0rt39 <YuibataMiraa@gmail.com>
Requires-Dist: g2p-en>=2.1.0,<3.0.0
Requires-Dist: nltk>=3.2.4,<4.0.0
Requires-Dist: e2k>=0.6.2,<1.0.0
Requires-Dist: nonebot2>=2.5.0,<3.0.0
Requires-Dist: aiofiles>=24.1.0,<30.0.0
Requires-Dist: httpx>=0.25.0,<1.0.0
Requires-Dist: nonebot-plugin-localstore>=0.7.0,<1.0.0
Requires-Python: >=3.10
Project-URL: Homepage, https://github.com/p0rt39/nonebot-plugin-just-enough-katakanas
Project-URL: Issues, https://github.com/p0rt39/nonebot-plugin-just-enough-katakanas/issues
Project-URL: Repository, https://github.com/p0rt39/nonebot-plugin-just-enough-katakanas.git
Description-Content-Type: text/markdown

<div align="center">
    <a href="https://v2.nonebot.dev/store">
    <img src="https://raw.githubusercontent.com/fllesser/nonebot-plugin-template/refs/heads/resource/.docs/NoneBotPlugin.svg" width="310" alt="logo"></a>

## ✨ Just Enough Katakanas ✨
[![LICENSE](https://img.shields.io/github/license/p0rt39/nonebot-plugin-just-enough-katakanas.svg)](./LICENSE)
[![pypi](https://img.shields.io/pypi/v/nonebot-plugin-just-enough-katakanas.svg)](https://pypi.python.org/pypi/nonebot-plugin-just-enough-katakanas)
[![python](https://img.shields.io/badge/python-3.10|3.11|3.12|3.13-blue.svg)](https://www.python.org)
[![uv](https://img.shields.io/badge/package%20manager-uv-black?style=flat-square&logo=uv)](https://github.com/astral-sh/uv)
[![ruff](https://img.shields.io/badge/code%20style-ruff-black?style=flat-square&logo=ruff)](https://github.com/astral-sh/ruff)

</div>

## 📖 介绍

通过词典查词或者使用[e2k](https://github.com/Patchethium/e2k/)和[g2p-en](https://github.com/Kyubyong/g2p)音转写,将英文单词或句子转换为日文片假名。

*更多功能 WIP*

## 💿 安装

<details open>
<summary>使用 nb-cli 安装</summary>
在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装

    nb plugin install nonebot-plugin-just-enough-katakanas --upgrade
使用 **pypi** 源安装

    nb plugin install nonebot-plugin-just-enough-katakanas --upgrade -i "https://pypi.org/simple"
使用**清华源**安装

    nb plugin install nonebot-plugin-just-enough-katakanas --upgrade -i "https://pypi.tuna.tsinghua.edu.cn/simple"


</details>

<details>
<summary>使用包管理器安装</summary>
在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令

<details open>
<summary>uv</summary>

    uv add nonebot-plugin-just-enough-katakanas
安装仓库 master 分支

    uv add git+https://github.com/p0rt39/nonebot-plugin-just-enough-katakanas@master
</details>

<details>
<summary>pdm</summary>

    pdm add nonebot-plugin-just-enough-katakanas
安装仓库 master 分支

    pdm add git+https://github.com/p0rt39/nonebot-plugin-just-enough-katakanas@master
</details>
<details>
<summary>poetry</summary>

    poetry add nonebot-plugin-just-enough-katakanas
安装仓库 master 分支

    poetry add git+https://github.com/p0rt39/nonebot-plugin-just-enough-katakanas@master
</details>

打开 nonebot2 项目根目录下的 `pyproject.toml` 文件, 在 `[tool.nonebot]` 部分追加写入

    plugins = ["nonebot_plugin_just_enough_katakanas"]

</details>

<details>
<summary>使用 nbr 安装(使用 uv 管理依赖可用)</summary>

[nbr](https://github.com/fllesser/nbr) 是一个基于 uv 的 nb-cli，可以方便地管理 nonebot2

    nbr plugin install nonebot-plugin-just-enough-katakanas
使用 **pypi** 源安装

    nbr plugin install nonebot-plugin-just-enough-katakanas -i "https://pypi.org/simple"
使用**清华源**安装

    nbr plugin install nonebot-plugin-just-enough-katakanas -i "https://pypi.tuna.tsinghua.edu.cn/simple"

</details>


## ⚙️ 配置

本插件暂无可用配置项 - WIP

## 🎉 使用
### 指令表
| 指令  | 权限  | 需要@ | 范围  |   说明   |
| :---: | :---: | :---: | :---: | :------: |
| ktkn <English_Content> | 群员  |  否   | 群聊  | 将<English_Content>转换为片假名 |
| ktknhelp | 群员  |  否   | 群聊  | 显示帮助菜单 |
| ktknstatus | 群员  |  否   | 群聊  | 显示词典链接情况和*插件自检 (WIP)* |

## License

- 代码部分: Apache-2.0 License.
- 词典部分: [Patchethium/e2k](https://github.com/Patchethium/e2k/releases/0.2.0) 提供的katakana_dict.jsonl, 本插件工作过程中会将其远程下载并按原样提供(provided as is), 继承 Wiktionary, JMdict/EDICT 的 CC-BY-SA。
