generate project readme using langgraphダウンロード - generate project readme using langgraphソースコードのダウンロード

generate project readme using langgraph

その他のソースコード

1.0.0

ダウンロード

rdmgen

rdmgen Amazon BedrockおよびLangGraph を使用してコードリポジトリ用の高品質のREADME.mdファイルを自動的に生成する Python CLI ツールです。

概要

このプロジェクトでは、Amazon Bedrock、LangGraph、LangChain AWS ライブラリを使用して、コードリポジトリの構造と内容を分析し、包括的な README.md ファイルを生成します。生成された README には、プロジェクトの概要、インストール手順、使用例、およびリポジトリ内のファイルに基づくその他の関連詳細が記載されています。

ワークフロー

特徴

自動化された README 生成: README ファイルを手動で作成する必要はもうありません。 rdmgen面倒な作業を行ってくれます。
ローカルまたはリモートリポジトリ: ローカルコードベースまたはリモート Git リポジトリの README ファイルの生成をサポートします。
実行の視覚化: 必要に応じて、LangGraph エージェントの実行フローを視覚化する図を生成します。
カスタマイズ可能な出力: 生成された README.md ファイルを指定したディレクトリに書き込みます。

インストール

注意: python >= 3.9が必要です。これはpython --versionで確認できます。基本環境に必要なバージョンがない場合は、必要なバージョンで仮想環境を作成し、「オプション 1」を使用してインストールします。

オプション 1: pip を使用する

リポジトリのクローンを作成した後、pip を使用してパッケージをインストールできます。

 pip install .

オプション 2: メイクファイル

いくつかのレシピを含む Makefile は Linux/MacOS で利用できます。専用の Python venv を作成し、仮想環境にrdmgenインストールするには、次のコマンドを実行します。

 make all

仮想環境の名前はデフォルトで.venvで、リポジトリと同じディレクトリにあります。

次に、次のコマンドを実行して環境をアクティブ化します。

 source .venv/bin/activate

venv のクリーンアップや削除などの make レシピの詳細については、 make helpの出力を確認してください。

使用法

前提条件

AWS 認証情報: cli コマンドを実行して README ファイルを生成する前に、AWS 認証情報が必要です。これを AWS 環境 (SageMaker Notebook インスタンスなど) 内から実行している場合は、ステップ 2 に進み、アタッチされた IAM ロールに正しいアクセス許可が付与されていることを確認できます。
IAM 権限: IAM ユーザーまたはロールには、選択したモデルに対して少なくとも次の権限が必要です (リソース * をモデル ID に置き換えます)。

{
    "Version" : " 2012-10-17 " ,
    "Statement" : [
        {
            "Sid" : " VisualEditor " ,
            "Effect" : " Allow " ,
            "Action" : [
                " bedrock:InvokeModel " ,
                " bedrock:InvokeModelWithResponseStream "
            ],
            "Resource" : " * "
        }
    ]
}

Amazon Bedrock のモデルアクセス: Amazon Bedrock Service の AWS コンソール経由で、選択したモデルにアクセスできることを確認します。

注:このプロジェクトでは、Amazon Bedrock の Claude 3 ソネット: anthropic.claude-3-sonnet-20240229-v1:0を使用します。アクセスできることを確認してください。モデル ID を変更したい場合は、 src/rdmgen/constants.pyでモデル ID を更新し、パッケージを再インストールしてください。

コマンド

リポジトリの README.md ファイルを生成するには、cli コマンドを実行します。

 rdmgen <REPO_PATH> --out <OUTPUT_FOLDER>

<REPO_PATH> : ローカルクローン/ディレクトリまたはリモート Git URL を指定できます。
<OUTPUT_FOLDER> : 出力 README.md ファイルを保存するパス。指定しない場合、ファイルはソースコードと同じディレクトリに保存されます。

オプションの--diagramフラグを渡すと、エージェントのフローチャートを作成して、エージェントが実行したステップを確認できます。

例

次の 2 つの例は、テスト用にこのリポジトリで利用できます。

 rdmgen test_data/hello_world

 rdmgen test_data/sensor_extraction --out ./output

GitHub 上の小規模なリモートリポジトリの例:

 rdmgen https://github.com/pypa/sampleproject --out output/sampleproject --diagram

制限事項

rdmgenユーティリティは現在、小規模から中規模のリポジトリで動作しますが、大規模なリポジトリについては、 src/constants.pyで定義されている次の調整可能な制限を考慮してください。

Amazon Bedrock read-timeout 、設定として Bedrock ランタイムクライアントに渡されます。詳細: https://repost.aws/knowledge-center/bedrock-large-model-read-timeouts
LangGraph recursion_limit 、グラフを呼び出すときに構成に渡されます。詳細: https://langchain-ai.github.io/langgraph/how-tos/recursion-limit/?h=recursion

発達

開発と拡張では、このプロジェクトでは依存関係の管理に Poetry を使用します。パッケージと依存関係をインストールするには、詩をインストールしてから次を実行します。

 poetry lock 
poetry install

安全

詳細については、「貢献」を参照してください。

貢献する

貢献は大歓迎です！改善やバグ修正がある場合は、問題をオープンするか、プルリクエストを送信してください。

改善の可能性:

どのファイルを読み取るかを決定するツールを追加します。つまり、重要でないファイルの読み取りをオプションにします。
README セクションごとにファイルを繰り返し読みます。つまり、最初に README テンプレートを作成し、次に各セクションをさらにループして、その特定のセクションにコンテンツを提供する可能性のあるファイルのみを読み取ります。おそらく次のようなパターンです: https://langchain-ai.github.io/langgraph/tutorials/plan-and-execute/plan-and-execute/