概要
Excelに記載されているコーディング規約をMarkdown形式に変換し、GROWIへAPI経由で取り込んでみました。
今回は以下の2ステップで実施しています。
- Excelのコーディング規約をChatGPTに渡し、Markdownに変換
- PythonスクリプトでGROWIのAPIを呼び出し、Markdownを登録
環境
今回の検証環境は以下です。
- WSL Ubuntu
- Docker インストール済
- GROWI は Docker Compose で起動
実施
0. GROWIのローカル環境構築
まず、GROWIをローカルで起動します。
git clone https://github.com/growilabs/growi-docker-compose.git growi
cd growi
docker compose up -d
起動できたらブラウザで開いて、GROWIの初期セットアップを行います。
http://localhost:3000/
1. Excelのコーディング規約をchatGPTに投げて、マークダウンファイルに変換
Excelのコーディング規約のサンプルとして、Javaコーディング規約 for Java8の内容をExcelに記載したものを用意しました。
このExcelファイルをChatGPTに渡し、GROWIに登録しやすいMarkdownファイル群へ変換してもらいました。
その結果、Markdownファイル群とAPI登録用のPythonスクリプトを含む growi_coding_rules.zip が生成されました。
今回生成したGROWIページ構成は以下の通りです。growi_coding_rules
/コーディング規約
/コーディング規約/ネーミング規約/全般
/コーディング規約/ネーミング規約/クラス
/コーディング規約/ネーミング規約/メソッド
2. GROWIのAPI Tokenを生成
GROWIにログインし、以下のURLからAPI Tokenを生成します。
http://localhost:3000/me
3. PythonでGROWIにAPI登録
Ubuntu上に growi_coding_rules.zip を展開し、import_to_growi.py を実行します。
まず、GROWIのURLとAPI Tokenを環境変数に設定します。
export GROWI_URL="http://localhost:3000"
export GROWI_TOKEN="発行したトークン"
次に、Pythonスクリプトを実行します。
python import_to_growi.py
これにより、Markdownファイルの内容がGROWIの各ページとして登録されます。
4. 登録結果を確認
GROWI上でページを確認すると、Excelに記載していたコーディング規約がMarkdown形式のWikiページとして登録されていました。
一部、タグ付けや一部の構成がおかしいが、おおむね想定通りにWiki化できました。
まとめ
Excelに記載してあるコーディング規約などの情報をGROWIにマークダウンで取り込むことで、将来的にAIに参照させやすくなるはず。
また、今後は画像付き、図形付きのExcelをどうGROWIに取り込むかも試してみたいです。