gaiah-toolkit 0.3.13

No project description provided

Gaiah

～Python Git Automation with Innovative Heuristics～

[🌐 Website] • [🐱 GitHub] [🐦 Twitter] • [🍀 Official Blog]

[!IMPORTANT] このリポジトリはSourceSageを活用しており、リリースノートやREADME、コミットメッセージの9割はSourceSage ＋ claude.aiで生成しています。

🌟 はじめに

Gaiahは、直感的でAIにやさしいメソッドを使用してGit操作を簡素化する革新的なPythonライブラリです。Gitリポジトリを制御するための高レベルなインターフェースを提供し、AIシステムがバージョン管理とシームレスに連携することを容易にします。新機能としてMarkdownから直接コミットを生成する機能が追加され、文書化されたコミットメッセージの管理がさらに効率的に行えます。

🚀 主な特徴

• 🤖 AIフレンドリー: AI主導の開発プロセスの独自の要件に対応するメソッドとユーティリティを提供し、AIを念頭に置いて設計されています。
• 🌐 リモートリポジトリのサポート: リモートリポジトリとのシームレスな連携を可能にし、GitHubやその他のGitホスティングプラットフォームにリポジトリを作成、クローン、プッシュできるようにします。
• 📂 リポジトリ管理: 新しいリポジトリの初期化、ファイルの追加、コミットの作成、ブランチの管理をシンプルなPythonコードを介して簡単に行うことができます。
• 🔧 カスタマイズ: 柔軟性とカスタマイズオプションを提供し、特定のニーズと設定に合わせてGitワークフローを調整できます。
• 📘 Markdownからのコミット生成: Markdown形式のドキュメントから直接コミットを生成する機能を追加し、文書化されたコミットメッセージの効率的な管理を可能にします。

📦 インストール

Gaiahの使用を開始するには、次の手順に従ってください:

1. 新しいconda環境を作成します:

   conda create -n gaiah python=3.11
   

2. conda環境をアクティベートします:

   conda activate gaiah
   

3. 必要な依存関係をインストールします:

   pip install gitpython python-dotenv PyGithub termcolor art
   

🎉 使用方法

CLI

GaiahのCLI機能により、コマンドラインから直接Git操作を行うことができます。例えば、以下のコマンドを使用してリポジトリにコミットを追加することができます:

gaiah

応用的な使い方

特定のプロジェクトディレクトリでGaiahを使用する場合、以下のようにリポジトリの場所やコミットメッセージのファイルパスを指定できます:

gaiah --repo_dir="C:\\Prj\\Gaiah_Sample02" --commit_msg_path=./tmp2.md

上記のコマンドでは、--repo_dirオプションでリポジトリのディレクトリを、--commit_msg_pathオプションでコミットメッセージが記載されたMarkdownファイルのパスを指定しています。

🤝 コミットメッセージの一括自動コミット

Gaiahでは、LLMを用いて生成したコミットメッセージを一括自動コミットすることができます。以下の手順でコミットメッセージを生成し、コミットを行います:

1. sourcesage/config/STAGE_INFO/STAGE_INFO_TEMPLATE_GAIAH.mdというフォーマットで、ステージング情報をLLMに渡します。

2. LLMは以下のような形式でコミットメッセージを生成します:

   Commit Messages フォーマット
   
   ## Commit 1
   
   ### README.md
   
   ```commit-msg
   📝 [docs] READMEに応用的な使い方セクションを追加
   
   - `README.md`ファイルに新たなセクションとして「応用的な使い方」を追加しました。これにより、ユーザーはGaiahを特定のプロジェクトディレクトリで使用する方法を具体的に学べるようになります。特に、リポジトリの指定やコミットメッセージのファイルパスを設定する具体的なコマンド例を示しています。  
   

   Commit 2

   gaiah/init.py

   🔖 [chore] Gaiahのバージョンを0.3.12に更新
   
   - `gaiah/__init__.py`でのバージョン番号を0.3.11から0.3.12へ更新しました。この更新は、最新の機能改善とバグ修正をユーザーに提供するためのものです。
   

3. 生成されたコミットメッセージを.Gaiah.mdファイルに貼り付けます。このファイルは、初回にgaiahコマンドを実行した際に自動で生成されます。

4. 再度gaiahコマンドを実行すると、.Gaiah.mdファイルからコミットメッセージが読み込まれ、自動的にコミットとプッシュが行われます。

🤝 貢献

Gaiahをさらに良くするために、コミュニティからの貢献を歓迎します。アイデア、提案、バグ報告がある場合は、GitHubリポジトリで issue を開くか、プルリクエストを送信してください。

📄 ライセンス

Gaiahは、MITライセンスの下でリリースされており、ライブラリの自由かつオープンソースでの使用、変更、配布が可能です。

🙏 謝辞

Gaiahは、以下のライブラリの優れた機能に基づいて構築されています:

• GitPython
• python-dotenv
• PyGithub
• termcolor
• art

これらのプロジェクトの開発者とコントリビューターの皆様が、オープンソースコミュニティに貴重な貢献をしてくださったことに感謝します。

---

Gaiahを使用してGitワークフローの自動化を開始し、AI主導の開発の力を解き放ちましょう! 🚀✨