AI 駆動開発スターターキット

Python による AI 駆動開発のための最小限・再利用可能なスターターキット

このリポジトリは、AI プロジェクトをすぐに始めたい開発者向けに、基本的なプロジェクト構成、テンプレート化機構、CI/CD パイプラインを提供します。

含まれているもの

基本的なプロジェクト構成
AI モデル（OpenAI SDK）を読み込み・利用するサンプルコード
シンプルな CLI エントリポイント
ユニットテスト
開発ガイドライン

セットアップ

Python の仮想環境を作成・有効化： sh python -m venv venv .\venv\Scripts\activate
依存関係をインストール： sh pip install -r requirements.txt

使い方

メインスクリプトを実行：

python -m src.main

情報収集

収集コマンドを使って、有益な情報やアイデアを手動で記録できます。保存先は実行ディレクトリの collected_data.json です。

# 引数あり（source と content を指定）
python -m src.main collect "survey" "users want simpler API"

# 引数を省略すると対話形式で入力を求められます
python -m src.main collect

# 収集データを要約表示する
python -m src.main analyze

# AI 要約付き分析
python -m src.main analyze --ai --model gpt-4o-mini

# 自動収集: GitHub / RSS / Survey(JSON)
python -m src.main fetch github microsoft/vscode open 20
python -m src.main fetch rss https://hnrss.org/frontpage 20
python -m src.main fetch survey-json survey.json content

# 分析結果の反映
python -m src.main apply-insights

# 週次レポート
python -m src.main weekly-report
python -m src.main weekly-report --ai

# Web UI
streamlit run src/dashboard.py

定期実行:

# 日次
powershell -ExecutionPolicy Bypass -File scripts/register_daily_task.ps1

# 週次（日曜 09:30）
powershell -ExecutionPolicy Bypass -File scripts/register_weekly_task.ps1

運用ドキュメント

Runbook（障害対応プレイブック）

テスト

pytest

注意事項

必要な AI ライブラリ（例: openai、transformers）を requirements.txt に追加してください。
環境変数（API キーなど）を適切に設定してください。

Cookiecutter テンプレート

cookiecutter-ai-starter/ にカスタマイズ可能なテンプレートが含まれています。これを使えば、自分のプロジェクト名や設定でスターターキットの新しいコピーをすばやく作成できます。

1. インストール

pip install cookiecutter        # まだインストールしていない場合

2. テンプレートから生成

cookiecutter d:\GitHub\start\cookiecutter-ai-starter

実行すると対話形式で以下のように質問されます（括弧内はデフォルト値）：

project_name [AI Starter Project]: My Awesome App
project_slug [ai_starter]: awesome_app
description [A minimal AI-driven development project]: An app that uses AI
python_version [3.11]: 3.11

入力が完了すると、現在のディレクトリに awesome_app というフォルダが作成され、その中にスターターキットのファイルがコピーされます。プロジェクト名やスラッグは cookiecutter.json 内で定義されている変数です。

3. 生成後の手順

cd awesome_app
python -m venv venv
.\venv\Scripts\activate
pip install -r requirements.txt

以降は通常のセットアップ・実行・テスト手順に従います。

4. テンプレートのカスタマイズ

cookiecutter.json に要素を追加すると、新たな質問が発生します。
テンプレート内のファイル名や内容で {{cookiecutter.<name>}} を利用すれば動的に置換されます。
たとえば、{{cookiecutter.project_slug}}/src/{{cookiecutter.project_slug}}.py のように書けます。

これにより、プロジェクト固有の情報をテンプレート化できます。

（このセクションはドキュメントに自動的に反映され、サイトにも詳細な説明が出力されます。）

Copilot / ChatGPT 向け指示

このスターターキットは GitHub Copilot や ChatGPT のチャット機能で “リポジトリの前提”を与えるためのサンプル指示ファイルを含みます。

指示は .github/instructions/common.instructions.md に置いてあります。

ファイル内では

---
description: リポジトリ全体の共通ガイドラインを Copilot Chat に提供します。
applyTo: "**/*"
---

のようにメタデータを記載でき、実際の指示を Markdown 形式で続けます。

詳細は Qiita 記事『Github Copilotを標準機能の範囲で賢くしよう』を参考に必要に応じてファイルを追加・編集してください。

ウェブサイト

ドキュメントサイトは docs/index.html にあり、リポジトリの Pages を有効にしてソースに docs/ を指定すると GitHub Pages で公開できます。このページにはセットアップ、実行、テスト、テンプレートの使い方が説明されています。

サイトは main ブランチへのプッシュごとに README や他の Markdown ソースから自動再生成されるため、スターターキットの最新状態を常に反映します。

ライセンス

このプロジェクトは MIT ライセンス下で公開されています。詳細は LICENSE ファイルを参照してください。