Metadata-Version: 2.5
Name: zenn-topic-suggester
Version: 0.2.4
Summary: Zennの記事に設定する最適なトピックを検索するCLIツール
Project-URL: Homepage, https://github.com/northward1/zenn-topic-suggester
Project-URL: Repository, https://github.com/northward1/zenn-topic-suggester
Project-URL: Issues, https://github.com/northward1/zenn-topic-suggester/issues
Author-email: northward <196759132+northward1@users.noreply.github.com>
License: MIT License
        
        Copyright (c) 2026 Northward
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: cli,zenn
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: Japanese
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.12
Requires-Dist: huggingface-hub>=1.33.0
Requires-Dist: numpy>=2.5.3
Requires-Dist: onnxruntime>=1.30.0
Requires-Dist: pandas>=3.0.6
Requires-Dist: platformdirs>=4.12.0
Requires-Dist: pyahocorasick>=2.3.1
Requires-Dist: requests>=2.34.2
Requires-Dist: transformers>=5.17.0
Description-Content-Type: text/markdown

# zenn-topic-suggester

[Zenn](https://zenn.dev/)に記事を投稿するときに設定できるトピックについて、記事の内容に合わせて最適なものを提案するCLIツールです。

## 概要

Zennに記事を投稿するとき、トピックを最大で5つ設定できます。  
ただ、トピックとして何が存在しているのかどうかを調べるのは少し手間がかかります。

また、あるトピックの投稿数が少ない場合、そのトピックに紐づけても関心を持つ人は少ないことが想定されます。

そこで`zenn-topic-suggester`では、直近半年でトピックに投稿された記事数のデータを利用し、直近半年で盛り上がっていて、かつ記事の内容にあうトピックを提案します。

直近半年でトピックに投稿された記事数のデータは適宜更新されます。

## インストール方法

以下のコマンドを実行します。Pythonのバージョンを3.12以降にする必要があることに注意してください。

```bash
pip install zenn-topic-suggester
```

## 使い方

`zenn-topic-suggester path/to/article.md`のように実行します。  
以下のように、推奨トピックがスコアの降順で出力されます。
スコアは現在、類似度や記事数の対数、完全に一致した単語があるかなどをもとに計算しており、これからも改善していく予定です。

```
- ai                   # スコア: 100.00, 完全一致: True 類似度: 0.74, 記事数: 8212
- 個人開発             # スコア:  97.94, 完全一致: True 類似度: 0.95, 記事数: 2829
- 生成ai               # スコア:  90.88, 完全一致: True 類似度: 0.94, 記事数: 1577
- 設計                 # スコア:  67.66, 完全一致: True 類似度: 0.64, 記事数: 768
- アーキテクチャ       # スコア:  63.00, 完全一致: True 類似度: 0.79, 記事数: 263
- api                  # スコア:  62.91, 完全一致: True 類似度: 0.71, 記事数: 369
...
```

初めて実行するとき、自然言語処理モデルのダウンロードが行われるので少し実行に時間がかかります。

### オプション

提示されるトピックの数を変更したいときは`zenn-topic-suggester path/to/article.md -n 50`のように指定します。デフォルトは20です。  
スコアのデータが必要ない場合は、`zenn-topic-suggester path/to/article.md -s`のように指定します。  
その他にもいくつかオプションがあります。`zenn-topic-suggester -h`でヘルプを表示して確認できます。
