generate project readme using langgraph تنزيل - generate project readme using langgraph

generate project readme using langgraph

شفرة المصدر الأخرى

1.0.0

تنزيل

com.rdmgen

rdmgen هي أداة Python CLI لإنشاء ملفات README.md عالية الجودة تلقائيًا لمستودعات التعليمات البرمجية باستخدام Amazon Bedrock و LangGraph .

ملخص

يستخدم هذا المشروع مكتبات Amazon Bedrock وLangGraph وLangChain AWS لتحليل بنية ومحتويات مستودع التعليمات البرمجية وإنشاء ملف README.md شامل. يوفر ملف README الذي تم إنشاؤه نظرة عامة على المشروع وتعليمات التثبيت وأمثلة الاستخدام والتفاصيل الأخرى ذات الصلة بناءً على الملفات الموجودة في المستودع.

سير العمل

سمات

إنشاء ملف README الآلي : لا مزيد من كتابة ملفات README يدويًا! يقوم rdmgen بالعمل الشاق نيابةً عنك.
المستودعات المحلية أو البعيدة : يدعم إنشاء ملفات README لقواعد التعليمات البرمجية المحلية أو مستودعات Git البعيدة.
تصور التنفيذ : قم بشكل اختياري بإنشاء رسم تخطيطي يصور تدفق تنفيذ وكيل LangGraph.
إخراج قابل للتخصيص : اكتب ملف README.md الذي تم إنشاؤه إلى أي دليل تحدده.

تثبيت

يرجى ملاحظة: أنت بحاجة إلى python >= 3.9 . يمكنك التحقق من ذلك باستخدام python --version . إذا لم تكن البيئة الأساسية الخاصة بك تحتوي على الإصدار المطلوب، فقم بإنشاء بيئة افتراضية بالإصدار المطلوب واستخدم "الخيار 1" للتثبيت.

الخيار 1: استخدام النقطة

يمكنك تثبيت الحزمة بالنقطة بعد استنساخ المستودع.

 pip install .

الخيار 2: Makefile

يتوفر ملف Makefile يحتوي على بعض الوصفات لنظام التشغيل Linux/MacOS. لإنشاء Python venv مخصص وتثبيت rdmgen في البيئة الافتراضية، قم بتشغيل:

 make all

يُطلق على البيئة الافتراضية اسم .venv افتراضيًا، وهي موجودة في نفس دليل المستودع.

الآن قم بتشغيل الأمر التالي لتنشيط البيئة:

 source .venv/bin/activate

لمزيد من وصفات الصنع مثل التنظيف وإزالة Venv، تحقق من إخراج make help .

الاستخدام

المتطلبات الأساسية

بيانات اعتماد AWS : قبل تشغيل أوامر cli لإنشاء ملف README، تكون بيانات اعتماد AWS مطلوبة. إذا كنت تقوم بتشغيل هذا من داخل بيئة AWS (على سبيل المثال، مثيل SageMaker Notebook)، فيمكنك المتابعة إلى الخطوة 2 لضمان منح الأذونات الصحيحة لدور IAM المرفق.
أذونات IAM : يجب أن يتمتع مستخدم أو دور IAM بالأذونات التالية على الأقل في النموذج المحدد (استبدل المورد * بمعرف (معرفات) النموذج):

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

الوصول إلى النموذج في Amazon Bedrock : تأكد من إمكانية وصولك إلى النموذج المحدد عبر وحدة تحكم AWS ضمن خدمة Amazon Bedrock.

ملحوظة: يستخدم المشروع السوناتة لكلود 3: anthropic.claude-3-sonnet-20240229-v1:0 من Amazon Bedrock. يرجى التأكد من أنه يمكنك الوصول إليه. إذا كنت ترغب في تغيير معرف النموذج، فيرجى تحديثه في src/rdmgen/constants.py وإعادة تثبيت الحزمة.

الأوامر

لإنشاء ملف README.md لمستودعك، قم بتشغيل الأمر cli:

 rdmgen <REPO_PATH> --out <OUTPUT_FOLDER>

<REPO_PATH> : يمكن أن يكون نسخة/دليل محلي أو عنوان URL بعيد لـ Git.
<OUTPUT_FOLDER> : المسار لحفظ ملف README.md الناتج فيه. إذا لم يتم تحديده، فسيتم حفظ الملف في نفس دليل التعليمات البرمجية المصدر.

يمكنك تمرير علامة --diagram الاختيارية لإنشاء مخطط انسيابي للوكيل لرؤية الخطوات التي تم تشغيلها.

أمثلة

يتوفر المثالان التاليان في هذا المستودع للاختبار:

 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 :

read-timeout Amazon Bedrock، والتي يتم تمريرها إلى عميل وقت تشغيل 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 lock 
poetry install

حماية

انظر المساهمة لمزيد من المعلومات.

المساهمة

المساهمات هي موضع ترحيب! الرجاء فتح مشكلة أو إرسال طلب سحب إذا كان لديك أي تحسينات أو إصلاحات للأخطاء.

التحسينات المحتملة:

قم بإضافة أداة لتحديد الملفات التي تريد قراءتها، أي جعل قراءة الملفات غير المهمة اختيارية.
اقرأ الملفات بشكل متكرر لكل قسم README. على سبيل المثال، قم أولاً بإنشاء قالب README، ثم قم بالتكرار خلال كل قسم واقرأ فقط الملفات التي قد تساهم في محتوى هذا القسم المحدد. ربما نمط مثل: https://langchain-ai.github.io/langgraph/tutorials/plan-and-execute/plan-and-execute/