gaiah-toolkit 0.5.1

No project description provided

Gaiah

～Python Git Automation with Innovative Heuristics～

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

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

🌟 はじめに

Gaiahは、初心者でも簡単に使えるPythonのライブラリです。Gitを使ってファイルの管理をするのを助けてくれます。新しいバージョンのGaiahでは、Markdownでコミットメッセージをかけるようになりました。

🚀 Gaiahの特徴

• 🤖 AIにやさしい: AIを使った開発に合わせて作られています。
• 🌐 リモートリポジトリ: GitHubなどのサービスとつながります。
• 📂 リポジトリ管理: 新しいリポジトリを作ったり、ファイルを追加したり、コミットしたり、ブランチを管理したりできます。
• 🔧 カスタマイズ: 自分の好みに合わせてGitの使い方を変えられます。
• 📘 Markdownでコミット: Markdownで書いたファイルからコミットメッセージを作れます。

📦 インストールの仕方

Gaiahを使うには、次のコマンドを実行してください:

pip install gaiah-toolkit

🎉 使い方

コマンドライン

Gaiahはコマンドラインから使えます。例えば、こんなふうにコミットできます:

gaiah

もっと細かく指定することもできます:

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

新しいリポジトリを作る

gaiah --create_repo --repo_name Gaiah_Sample05 --description "Gaiah_Sample05 repo" --init_repo --repo_dir C:\Prj\Gaiah_Sample\Gaiah_Sample05 --process_commits --commit_msg_path .Gaiah.md

.Gaiah.mdのコミットメッセージを一括送信

Gaiahでは、.Gaiah.mdファイルにMarkdown形式でコミットメッセージをまとめて書いておくことができます。そして、次のコマンドを実行すると、.Gaiah.mdに書かれたコミットメッセージが一括でリポジトリに送信されます:

gaiah --process_commits

このコマンドを使えば、たくさんのコミットメッセージを一度に処理できるので、とても便利です。

Gaiahの中身

Gaiahの処理の流れは、次の図のようになっています:

graph TD
   A[ユーザーがコマンドを実行] --> B{コマンドを読み取る}
   B --> C{Gaiahを準備}
   C --> D{新しいリポジトリを作る?}
   D -->|Yes| E[GitHubに新しいリポジトリを作る]
   E --> E1[.envファイルから情報を読む]
   E1 --> E2[トークンを取得]
   E2 --> E3[GitHubとつなぐ]
   E3 --> E4[リポジトリ名などを設定]
   E4 --> E5[リポジトリを作る]
   E5 --> E6[完了メッセージを出す]
   E6 --> Q[おしまい]
   D -->|No| F{コミットする?}
   F -->|Yes| G[Markdownファイルからコミットを作る]
   G --> H[全部のファイルをアンステージ]
   H --> I{コミットを1つずつ処理}
   I --> J{ファイル名とコミットメッセージを取得}
   J --> K{ファイルを処理}
   K --> L{ファイルをステージ}
   L --> M{変更をコミット}
   M --> N{次のコミットある?}
   N -->|Yes| I
   N -->|No| O[リモートにプッシュ]
   O --> P[おしまい]
   F -->|No| Q[おしまい]

開発者向け

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

   conda create -n gaiah python=3.11
   

2. conda環境に入ります:

   conda activate gaiah
   

3. 必要なものをインストールします:

   pip install gitpython python-dotenv PyGithub termcolor art
   

便利なコマンド:

script\activate-gaiah.bat

gaiah --repo_dir C:\Prj\Gaiah_Sample\Gaiah_Sample05 --process_commits
gaiah --create_repo --repo_name AIRA --description "AIRA: AI-Integrated Repository for Accelerated Development" --init_repo --repo_dir C:\Prj\AIRA --process_commits --commit_msg_path .Gaiah.md

🤝 みんなでGaiahを良くしよう

Gaiahをもっと良くするアイデアや、バグを見つけたら、GitHubのページで教えてください。

📄 ライセンス

GaiahはMITライセンスで公開されているので、自由に使ったり、変えたり、配ったりできます。

🙏 感謝

Gaiahは、次のようなすばらしいライブラリのおかげで作ることができました:

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

これらを作ってくれた人たちに感謝します。

---

さあ、Gaiahを使ってGitを楽しく使いこなしましょう! 🚀✨