title	emoji	colorFrom	colorTo	sdk	sdk_version	app_file	pinned	license
HarmonAI III	🦀	green	blue	streamlit	1.39.0	app.py	false	mit

🌟 HarmonAI III 🌟

～ AI-Powered Automated Repository Management Template ～

Important

HarmonAI IIIは、cline (旧:Claude Dev), SourceSage, claude.aiを活用して開発されたテンプレートリポジトリです。リリースノート、README、コミットメッセージの大部分は、最新のAI技術を用いて生成されています。

🚀 プロジェクト概要

HarmonAI IIIは、AIRAとIRISを統合した革新的なAIリポジトリスターターキットです。このリポジトリは、LLMを活用したAI開発プロジェクトの構造とワークフローを提供し、開発者の作業効率を劇的に向上させることを目的としています。バージョン: v1.3.0

🆕 最新情報

• 🎉 v1.3.0リリース: Streamlitアプリの基本構造作成、READMEファイルのデザイン改善、いくつかのバグ修正、およびドキュメントの更新を行いました。 StreamlitアプリではREADME.mdファイルを読み込んで表示する機能を実装しました。 README.mdファイルが存在しない場合のエラー処理も追加されています。 さらに、GitHubリポジトリへのコラボレーター追加スクリプト、Hugging Face Hubへの自動同期ワークフロー、PyPIへの自動デプロイワークフローを追加しました。

✨ 主な機能

1. 統合AIツールセット: AIRAとIRISの機能を1つのパッケージで提供
2. 即時利用可能: テンプレートとして使用することで、高品質な初期構造を持つリポジトリを簡単に作成
3. 自動化された開発ワークフロー: コミットメッセージ生成、リリースノート作成、イシュー管理の自動化
4. 多言語サポート: READMEの自動翻訳機能により、国際的なプロジェクト展開をサポート
5. 柔軟なカスタマイズ: プロジェクトのニーズに合わせて容易に調整可能
6. コラボレーター自動招待: GitHub APIを利用したコラボレーター招待スクリプト
7. Streamlitアプリ: README.mdファイルを表示する基本的なStreamlitアプリケーション

🔧 使用方法

Streamlitアプリの実行

1. pip install -r requirements.txt で必要なパッケージをインストールします。
2. streamlit run app.py を実行します。

AIRAの使用例：

aira --mode sourcesage commit  --config=.aira\config.dev.commit.yml --ss-model-name="gpt-4o-mini" --llm-output="llm_output.md"

IRISの使用例：

詳細な使用方法については、各コンポーネントのドキュメンテーションを参照してください。

📦 インストール手順

1. このリポジトリをテンプレートとして使用し、新しいリポジトリを作成します。
2. リポジトリをローカルにクローンします。
3. 必要な依存関係をインストールします：

   pip install -r requirements.txt

4. AIRAとIRISの設定ファイルをカスタマイズします。
5. GitHub Actionsの設定を確認し、必要に応じて環境変数を設定します。
6. .github/release_notes/.sourcesage_releasenotes_iris.ymlファイルを開き、repo-name:の値を新しいリポジトリ名に修正します。

🌿 環境構築

HarmonAI IIIの環境を構築するには、以下の手順に従ってください：

1. 仮想環境を作成します：

   python3 -m venv .venv

   これにより、.venvディレクトリに仮想環境が作成されます。

2. 仮想環境をアクティベートします：

   source .venv/bin/activate  # Linux/macOS
   .venv\Scripts\activate  # Windows

3. 依存関係をインストールします：

   pip install -r requirements.txt

これらの手順により、HarmonAI IIIの開発環境が整います。

📚 主要コンポーネント

🤖 AIRA (AI-Integrated Repository for Accelerated Development)

• リポジトリ作成の自動化
• コミットメッセージの自動生成

🌈 IRIS (Intelligent Repository Issue Solver)

• イシューの自動分類
• 解決策の自動提案
• リリースノートの自動生成
• READMEの自動翻訳

🤝 コラボレーターの自動招待

HarmonAI IIIには、GitHubリポジトリにコラボレーターを自動で招待するスクリプトが含まれています。以下の手順で使用できます：

1. .env ファイルを作成し、必要なトークンを設定します：

   # GitHubアクセストークン（コラボレーター招待用）
   GITHUB_TOKEN=your_github_personal_access_token_here
   
   # 以下は他の機能で使用する可能性のあるトークンの例です。記載しておくと後々便利です。
   # GITHUB_ACCESS_TOKEN=ghp_xxxxx
   # YOUR_PERSONAL_ACCESS_TOKEN_IRIS=ghp_yyyyy
   # GEMINI_API_KEY=AIzzzzz
   

   注意: .env ファイルは .gitignore に含めて、リポジトリにコミットしないようにしてください。

2. 以下のコマンドを実行してコラボレーターを招待します：

   python .github/github_add_collaborator.py Sunwood-ai-labs/HarmonAI_III username_to_invite

   username_to_invite は招待したいGitHubユーザー名に置き換えてください。

3. スクリプトが正常に実行されると、指定したユーザーにコラボレーター招待が送信されます。

注意事項：

• このスクリプトを使用するには、GitHubトークンに適切な権限（repo スコープ）が必要です。
• 組織のリポジトリに対して使用する場合は、組織の設定で適切な権限が付与されていることを確認してください。
• セキュリティのため、トークンは定期的に更新し、必要最小限の権限のみを付与するようにしてください。
• .env ファイルやトークンを含む情報は、決して公開リポジトリにコミットしないでください。

この機能により、プロジェクトへの新しいコントリビューターの追加プロセスが簡素化されます。セキュリティを維持しながら、効率的にチームを拡大することができます。

🐈 処理フロー

%%{init:{'theme':'base','themeVariables':{'primaryColor':'#024959','primaryTextColor':'#F2C335','primaryBorderColor':'#F2AE30','lineColor':'#A1A2A6','secondaryColor':'#593E25','tertiaryColor':'#F2C335','noteTextColor':'#024959','noteBkgColor':'#F2C335','textColor':'#024959','fontSize':'18px'}}}%%

graph LR
    A[開始] --> B[リポジトリの構想とネーミング]
    B -->|人間が実施| C[HarmonAI IIIによる<br>リポジトリ初期化]
    C -->|自動化| D[開発作業]
    D -->|人間が実施| E[AIRAによる<br>コミット自動化]
    E --> H[IRISによる<br>リリースノート作成]
    H --> I[IRISによる<br>ドキュメント翻訳]
    I --> J[リリース]
    J --> K[終了]

    class B,D,G human;
    class E aira;
    class F,H,I iris;
    class C auto;
    class A,J,K process;

Loading

🤝 コントリビューション

HarmonAI IIIは、オープンソースプロジェクトとしてコミュニティからの貢献を歓迎しています。バグ報告、機能リクエスト、プルリクエストを通じて、このテンプレートリポジトリの改善にご協力ください。

📄 ライセンス

HarmonAI IIIは、MITライセンスの下で公開されています。

🙏 謝辞

HarmonAI IIIの開発にあたり、多くのオープンソースプロジェクトからインスピレーションを得ています。特に、AIRAとIRISの開発者の皆様に深く感謝申し上げます。iris-s-coon、Maki様にも感謝いたします。

---

HarmonAI IIIは、AI駆動の開発プロセスを実現する優れたスターターキットです。このテンプレートを基に、革新的なAIプロジェクトの開発を始めましょう！