Metadata-Version: 2.3
Name: zenn-topic-suggester
Version: 0.1.2
Summary: Zennの記事に設定する最適なトピックを検索するCLIツール
Keywords: zenn,cli
Author: northward
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.
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Natural Language :: Japanese
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: transformers>=5.17.0
Requires-Python: >=3.12
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
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-suggest path/to/article.md`のように実行します。  
以下のように、推奨トピックがスコアの降順で出力されます。
スコアは現在、類似度と記事数の対数をもとに計算していますが、改善していく予定です。

```
- javascript           # スコア: 0.95, 類似度: 1.00, 直近半年の記事数: 767
- githubactions        # スコア: 0.93, 類似度: 1.00, 直近半年の記事数: 487
- postgresql           # スコア: 0.90, 類似度: 0.98, 直近半年の記事数: 284
- typescript           # スコア: 0.90, 類似度: 0.93, 直近半年の記事数: 1536
- 開発環境                 # スコア: 0.90, 類似度: 0.99, 直近半年の記事数: 122
...
```

行数を変更したいときは`zenn-topic-suggest path/to/article.md -n 50`のように指定して、提示されるトピックの数を変更できます。デフォルトは20です。  
初めて実行するときに自然言語処理モデルのダウンロードが行われるので、少し実行に時間がかかります。
