generate project readme using langgraph Download - generate project readme using langgraph Unduh kode sumber

generate project readme using langgraph

Kode sumber lainnya

1.0.0

Unduh

rdmgen

rdmgen adalah alat Python CLI untuk secara otomatis menghasilkan file README.md berkualitas tinggi untuk repositori kode menggunakan Amazon Bedrock dan LangGraph .

Ringkasan

Proyek ini menggunakan perpustakaan Amazon Bedrock, LangGraph, dan LangChain AWS untuk menganalisis struktur dan konten repositori kode dan menghasilkan file README.md yang komprehensif. README yang dihasilkan memberikan gambaran umum proyek, instruksi instalasi, contoh penggunaan, dan detail relevan lainnya berdasarkan file di repositori.

Alur kerja

Fitur

Pembuatan README Otomatis : Tidak perlu lagi menulis file README secara manual! rdmgen melakukan kerja keras untuk Anda.
Repositori Lokal atau Jarak Jauh : Mendukung pembuatan file README untuk basis kode lokal atau repositori Git jarak jauh.
Visualisasi Eksekusi : Secara opsional, buat diagram yang memvisualisasikan alur eksekusi agen LangGraph.
Output yang Dapat Disesuaikan : Tulis file README.md yang dihasilkan ke direktori mana pun yang Anda tentukan.

Instalasi

Harap Dicatat: Anda memerlukan python >= 3.9 . Anda dapat memeriksanya dengan python --version . Jika lingkungan dasar Anda tidak memiliki versi yang diperlukan, buatlah lingkungan virtual dengan versi yang diperlukan dan gunakan "Opsi 1" untuk menginstal.

Opsi 1: Menggunakan pip

Anda dapat menginstal paket dengan pip setelah mengkloning repositori.

 pip install .

Opsi 2: Makefile

Makefile dengan beberapa resep tersedia untuk linux/MacOS. Untuk membuat venv Python khusus dan menginstal rdmgen di lingkungan virtual, jalankan:

 make all

Virtual env diberi nama .venv secara default, dan terletak di direktori yang sama dengan repositori.

Sekarang jalankan perintah berikut untuk mengaktifkan lingkungan:

 source .venv/bin/activate

Untuk resep pembuatan lainnya seperti membersihkan dan melepas venv, periksa keluaran make help .

Penggunaan

Prasyarat

Kredensial AWS : Sebelum menjalankan perintah cli untuk menghasilkan file README, kredensial AWS diperlukan. Jika Anda menjalankan ini dari dalam lingkungan AWS (misalnya instans Notebook SageMaker), Anda dapat melanjutkan ke langkah 2 untuk memastikan izin yang benar diberikan ke IAM Role yang terlampir.
Izin IAM : Pengguna atau Peran IAM harus memiliki setidaknya izin berikut pada model yang dipilih (ganti sumber daya * dengan id model):

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

Akses model di Amazon Bedrock : pastikan Anda memiliki akses ke model yang dipilih melalui Konsol AWS di bawah Amazon Bedrock Service.

Catatan: Proyek ini menggunakan soneta Claude 3: anthropic.claude-3-sonnet-20240229-v1:0 dari Amazon Bedrock. Harap pastikan Anda memiliki akses ke sana. Jika Anda ingin mengubah ID model, harap perbarui di src/rdmgen/constants.py dan instal ulang paketnya.

Perintah

Untuk menghasilkan file README.md untuk repositori Anda, jalankan perintah cli:

 rdmgen <REPO_PATH> --out <OUTPUT_FOLDER>

<REPO_PATH> : dapat berupa klon/direktori lokal atau URL Git jarak jauh.
<OUTPUT_FOLDER> : jalur untuk menyimpan file README.md keluaran. Jika tidak ditentukan, file disimpan ke direktori yang sama dengan kode sumber.

Anda dapat meneruskan tanda --diagram opsional untuk membuat diagram alur agen guna melihat langkah-langkah yang dijalankannya.

Contoh

Dua contoh berikut tersedia di repositori ini untuk pengujian:

 rdmgen test_data/hello_world

 rdmgen test_data/sensor_extraction --out ./output

Contoh untuk repositori jarak jauh kecil di GitHub:

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

Keterbatasan

Utilitas rdmgen saat ini berfungsi untuk repositori ukuran kecil hingga menengah, pertimbangkan batasan yang dapat disesuaikan berikut untuk repositori besar, yang ditentukan dalam src/constants.py :

Amazon Bedrock read-timeout , yang diteruskan ke klien runtime Bedrock sebagai konfigurasi, detail selengkapnya: https://repost.aws/knowledge-center/bedrock-large-model-read-timeouts
LangGraph recursion_limit , yang diteruskan ke konfigurasi saat memanggil grafik. Detail lebih lanjut: https://langchain-ai.github.io/langgraph/how-tos/recursion-limit/?h=recursion

Perkembangan

Untuk pengembangan dan perluasan, proyek ini menggunakan Puisi untuk manajemen ketergantungan. Untuk menginstal paket dan dependensinya, instal puisi lalu jalankan:

 poetry lock 
poetry install

Keamanan

Lihat KONTRIBUSI untuk informasi lebih lanjut.

Berkontribusi

Kontribusi dipersilahkan! Silakan buka masalah atau kirimkan permintaan penarikan jika Anda memiliki perbaikan atau perbaikan bug.

Potensi Peningkatan:

Tambahkan Alat untuk memutuskan file mana yang akan dibaca, yaitu menjadikannya opsional untuk membaca file yang tidak penting.
Baca file secara berulang untuk setiap bagian README. yaitu Pertama-tama buatlah template README, lalu ulangi setiap bagian dan baca hanya file yang mungkin menyumbangkan konten ke bagian tersebut. Mungkin polanya seperti: https://langchain-ai.github.io/langgraph/tutorials/plan-and-execute/plan-and-execute/