codebase dump
v0.6.0
هذا المشروع عبارة عن إصدار خفيف الوزن من Codebase Digest ، مصمم لتحليل وتلخيص قاعدة الشفرة الخاصة بك في تفريغ ملف واحد. يشمل الإخراج المولد:
يمكن استخدام هذا الإخراج كمدخلات لنماذج اللغة الكبيرة (LLMS) مثل ChatGPT و Google Gemini وغيرها لمزيد من التحليل أو لدعم المهام القائمة على المطالبة.
للإلهام على المطالبات المحتملة ، راجع قسم مطالبات LLM في مستودع Digest Codebase.
يمكنك تثبيت dumbum codebase مباشرة من PYPI:
pip install codebase-dumpاستنساخ إعداد مستودع
git clone https://github.com/your-username/codebase-dump.git
cd codebase-dump
pip install -r requirements.txtأوصي بفتح هذا المشروع في Visual Studio Code وإعداد بيئة افتراضية.
بمجرد التثبيت ، يمكنك تشغيل Dupbase Dump من سطر الأوامر:
codebase-dump < path_to_codebase > -f < output_filename > -o < output_format >| خيار | وصف |
|---|---|
path_to_directory | طريق إلى الدليل الذي تريد تحليله |
-o, --output-format | تنسيق الإخراج (نص ، تخفيض). الافتراضي: نص |
-f, --file | اسم ملف الإخراج |
--max-size | أقصى حجم محتوى النص المسموح به في كيلو بايت (افتراضي: 10240 كيلو بايت) |
--ignore-top-large-files | عدد أكبر الملفات التي يجب تجاهلها (افتراضي: 0) |
--audit-upload | أرسل الإخراج إلى API Audits على النحو المحدد بواسطة --audit-base-url |
--audit-base-url | عنوان URL الأساسي API لإرسال التدقيق إلى (افتراضي: https://codeaudits.ai/) |
--api-key | مفتاح واجهة برمجة التطبيقات الخاصة الخاصة بك لتعيين مستودع تم إرساله إلى حسابك على https://codeaudits.ai/ |
قم بإنشاء ملف Markdown لهيكل رمز مشروعك:
codebase-dump . -f project_dump_for_llm.md -o markdownقم بإنشاء ملف Markdown ودفعه إلى Audits App Codeaudits.ai:
codebase-dump . -o markdown --audit-uploadقم بإنشاء ملف Markdown ودفعه إلى مثيل Audits المخصص:
codebase-dump . -o markdown --audit-upload --audit-base-url https://your-audit-instance.com/قم بإنشاء ملف Markdown مع تجاهل أفضل 5 ملفات أكبر ودفعه إلى Audits App Codeaudits.ai:
codebase-dump . -o markdown --audit-upload --ignore-top-large-files=5يمكنك أيضًا تشغيل dumbase codebase مباشرة من الرمز المصدر:
pip install -e .
python src/codebase_dump/app.py < path_to_codebase > -f < output_filename > -o < output_format >يمكنك تجربة تفريغ Codebase في بيئة عبر الإنترنت ، Google Colab. يمكن أن يكون خيارًا جيدًا إذا لم يكن لديك بيئة بيثون على جهاز الكمبيوتر الخاص بك. فقط قم بتشغيله هنا: Codebase Dump Colab. لاختبارها ، قم بتشغيل جميع التعليمات البرمجية عبر وقت التشغيل -> قم بتشغيل الكل.
يمكنك أتمتة تفريغ CodeBase في عمل GitHub لإنشاء وحفظ تفريغ الكود كقنين. إليك مثال تكوين سير العمل (مثال العمل المتاح في هذا المستودع الخاص: .github/سير العمل/codebase_dump.yml).
name : Generate Project Dump for LLM
on :
workflow_dispatch :
jobs :
generate-file :
runs-on : ubuntu-latest
steps :
- name : Checkout code
uses : actions/checkout@v4
- name : Set up Python
uses : actions/setup-python@v3
with :
python-version : " 3.10 "
- name : Install codebase-dump
run : pip install codebase-dump
- name : Generate Single-File Prompt for LLM
run : codebase-dump . -f project_dump_for_llm.md -o markdown --audit-upload
- name : Upload Prompt File as Artifact
uses : actions/upload-artifact@v3
with :
name : project_dump_for_llm.md
path : project_dump_for_llm.mdفي هذا المثال:
بمجرد حصولك على تفريغ CodeBase ، انسخ ذلك إلى واحدة من LLMs كمطالبة إدخال وابدأ في طرح أسئلة Gemini و ChatGpt و Claude وغيرها المتعلقة بـ CodeBase. على سبيل المثال ، اسأل عن "ما هي الخطوات المقترحة لإعادة تشكيل هذا الرمز إلى // اختيارك // المعمارية.".
للإلهام على المطالبات المحتملة ، تحقق من قسم مطالبات LLM في مستودع Digest Codebase.
تم تحميل قاعدة الكود المتخصصة أيضًا إلى https://codeaudits.ai/ التطبيق. عندما تقوم بتشغيل الرابط الذي تم إرجاعه إليك ، يمكنك تشغيل بعض عمليات تدقيق التعليمات البرمجية التي تم تكوينها مسبقًا ، مثل تلميحات إعادة إنشاء الهندسة المعمارية أو الاختبارات المفقودة أو تلميحات التبسيط.
