这是indexloc提供的服务,不要输入任何密码
Skip to content

Sunwood-ai-labs/SourceSage

Repository files navigation


SourceSage

~Transforming code for AI~
PyPI - Version PyPI - Format PyPI - Implementation PyPI - Status PyPI - Downloads PyPI - Downloads

SourceSage - Sunwood-ai-labs GitHub Repo stars forks - Sunwood-ai-labs GitHub Last Commit GitHub Top Language GitHub Release GitHub Tag GitHub Actions Workflow Status

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

SourceSageは、リポジトリの構造と内容を包括的に分析し、AIフレンドリーなドキュメントを生成するツールです。主にRepository_summary.mdの生成とRELEASE_REPORTの作成機能を提供します。

Important

このリポジトリのリリースノートやREADME、コミットメッセージの9割近くはclaude.aiChatGPT4を活用したAIRA, SourceSage, Gaiah, HarmonAI_IIで生成しています。

更新内容

🎯 主な機能

SourceSageはシンプルで軽量なリポジトリ分析ツールで、以下の2つの主要機能を提供します:

1. 📋 Repository Summary Generation

リポジトリの構造、コミット情報、ファイル統計を包括的に分析し、AIフレンドリーなマークダウンドキュメントを生成します。

出力ファイル: .SourceSageAssets/DOCUMIND/Repository_summary.md

含まれる情報:

  • 🌳 プロジェクトツリー構造
  • 📋 Gitリポジトリ情報
  • 📈 ファイルサイズと行数統計
  • 📝 ファイル内容の詳細

2. 📄 Release Report Generation

Gitタグ間の差分を分析し、リリースレポートを自動生成します。

出力ファイル: .SourceSageAssets/RELEASE_REPORT/Report_{latest_tag}.md

含まれる情報:

  • 🏷️ バージョン比較
  • 🔄 変更差分の詳細
  • 📋 コミット履歴

🚀 クイックスタート

📦 インストール

pipでのインストール

pip install sourcesage

uvでの環境構築(推奨)

# プロジェクトをクローン
 git clone https://github.com/Sunwood-ai-labs/SourceSage.git
 cd SourceSage

# 環境構築と依存関係のインストール
uv sync

# 実行
uv run sourcesage
# または短縮コマンド
uv run ss

🗺️ 基本的な使用方法

Repository Summaryの生成

# フルコマンド
sourcesage

# 短縮コマンド
ss

出力: .SourceSageAssets/DOCUMIND/Repository_summary.md

Release Reportの生成

# Repository Summary + Release Reportを同時生成
sourcesage --ss-mode GenerateReport

# 短縮コマンド
ss --ss-mode GenerateReport

出力: .SourceSageAssets/RELEASE_REPORT/Report_{latest_tag}.md

主なオプション

# 特定のモードで実行
ss --ss-mode Sage                 # Repository Summaryのみ
ss --ss-mode GenerateReport       # Release Reportのみ  
ss --ss-mode all                  # すべての機能(デフォルト)

# 出力ディレクトリの指定
ss --ss-output ./custom-output/

# 無視ファイルの指定
ss --ignore-file .gitignore

📊 生成される内容例

Repository Summary

# Project: SourceSage

```plaintext
OS: posix
Directory: /path/to/project

├── .SourceSageignore
├── pyproject.toml
├── sourcesage/
│   ├── __init__.py
│   ├── cli.py
│   └── modules/
│       ├── DocuSum/
│       └── DiffReport/
│           ├── __init__.py
│           ├── git_diff.py
│           └── markdown_report.py
└── README.md

📊 プロジェクト統計

  • 📅 作成日時: 2025-02-02 16:22:31
  • 📁 総ディレクトリ数: 5
  • 📄 総ファイル数: 15
  • 📏 最大深度: 3

## 🛠️ 開発環境

SourceSageは現代的なPython開発環境をサポートしています:

- **Python**: 3.8以降
- **パッケージ管理**: uv / pip
- **ビルドシステム**: hatchling
- **設定ファイル**: pyproject.toml

### 開発用セットアップ

```bash
# uvを使った開発環境構築
git clone https://github.com/Sunwood-ai-labs/SourceSage.git
cd SourceSage
uv sync

# テスト実行
uv run pytest

# コードフォーマット
uv run black sourcesage/
uv run isort sourcesage/

# パッケージビルド
uv build

💡 使用例

CI/CDでの活用

- name: Generate Repository Summary
  run: |
    pip install sourcesage
    ss
    
- name: Generate Release Report  
  run: |
    ss --ss-mode GenerateReport

プロジェクト分析の自動化

#!/bin/bash
# 複数プロジェクトの一括分析
for dir in */; do
    cd "$dir"
    ss --ss-output "../analysis/$dir"
    cd ..
done

貢献

SourceSageの改善にご協力ください!バグの報告や機能追加の提案がある場合は、GitHubリポジトリでIssueを開くかプルリクエストを送信してください。

ライセンス

このプロジェクトはMITライセンスの下で公開されています。

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages