الصفحة الرئيسية>المتعلقة بالبرمجة>شفرة المصدر الأخرى
تنزيل

مصممة للبساطة والتخصيص وإنتاجية المطور.

روابط سريعة

  1. ملخص

  2. العرض التوضيحي

  3. سمات

  4. ابدء

  5. إعدادات

  6. أمثلة

  7. المساهمة

مهم

قم بزيارة الوثائق الرسمية للحصول على أدلة ودروس تعليمية مفصلة.

ملخص

README-AAI هي أداة مطور تقوم تلقائيًا بإنشاء ملفات README MERLOMDER باستخدام محرك معالجة مستودع قوي ونماذج لغة متقدمة. ما عليك سوى توفير عنوان URL أو مسار إلى قاعدة قاعدة الشفرة الخاصة بك ، وسيتم إنشاء ReadMe منظمة ومفصلة.

لماذا readme-ai؟

تم تصميم هذه الأداة لتبسيط عملية الوثائق للمطورين ، وتوفير الوقت والجهد مع ضمان ملفات ReadMe عالية الجودة. تشمل الفوائد الرئيسية:

  • منظمة العفو الدولية التي تعمل بذواق الاعتماد: استفادة من نماذج اللغة لتوليد المحتوى الذكي.

  • الاتساق: ضمان وثائق نظيفة وموحدة عبر المشاريع.

  • التخصيص: تخصيص الإخراج لتناسب متطلبات مشروعك.

  • اللغة اللاأدرالية: تعمل مع معظم لغات البرمجة/الأطر.

  • وفر الوقت: إنشاء readmes شاملة في أقل من دقيقة.

العرض التوضيحي

الركض من سطر الأوامر:

readmeai-cli-demo.mov

الجري مباشرة في متصفحك:

readmeai-streamlit-demo.mov

سمات

  • الوثائق الآلية: قم بإنشاء ملفات README شاملة تلقائيًا من قاعدة الكود الخاصة بك.

  • الإخراج القابل للتخصيص: تخصيص التصميم والتنسيق والشارات وتصميمات الرأس والمزيد من التفضيلات.

  • الخلفية المرنة: الاندماج بسلاسة مع OpenAI ، Ollama ، Anthropic ، Google Gemini .

  • اللغة اللاأسية: متوافقة مع مجموعة واسعة من لغات البرمجة وأنواع المشاريع.

  • الوضع غير المتصل: إنشاء ملفات README BOALERPLATE في وضع عدم الاتصال ، دون أي مكالمات API خارجية.

  • أفضل الممارسات: يضمن الوثائق النظيفة والمهنية ، التمسك بأفضل الممارسات.

دعونا نلقي نظرة على بعض التخصيصات الممكنة التي أنشأتها README-AI:

pip

الطريقة الموصى بها لمعظم المستخدمين:

 ❯ PIP تثبيت readMeai

PIPX

استخدم pipx لاستخدام readmeai في بيئة معزولة ، وضمان عدم وجود تعارضات تبعية مع مشاريع بيثون الأخرى:

 ❯ Pipx تثبيت readMeai

الأشعة فوق البنفسجية

استخدم الأشعة فوق البنفسجية لأسرع طريقة لتثبيت readmeai بأمر واحد:

 ❯ أداة UV تثبيت READMEAI

عامل ميناء

لتشغيل readmeai في بيئة حاوية ، اسحب أحدث صورة Docker من Docker Hub:

 ❯ Docker Pull Zeroxeli/README-AI: أحدث

من المصدر

انقر لتوسيع التعليمات

  1. استنساخ المستودع:

     ❯ git clone https://github.com/eli64s/readme-ai

  2. انتقل إلى دليل readme-ai :

     cd cd readme-ai

  3. تثبيت التبعيات:

     ❯ PIP تثبيت -r الإعداد/المتطلبات. txt

بدلاً من ذلك ، يمكن إعداد المشروع باستخدام نص Bash أدناه:

سحق

  1. قم بتشغيل البرنامج النصي الإعداد:

     bash إعداد/setup.sh

أو استخدم poetry لبناء المشروع:

شِعر

  1. تثبيت التبعيات باستخدام الشعر:

     ❯ تثبيت الشعر

مهم

لاستخدام عملاء الأنثروبور و Google Gemini ، هناك حاجة إلى تبعيات إضافية. قم بتثبيت الحزمة مع الإضافات التالية:

  • الأنثروبور:

     ❯ PIP تثبيت "READMEAI [الإنسان]"

  • Google Gemini:

     pip تثبيت "readMeai [google-generativeai]"

  • تثبيت العديد من العملاء:

     ❯ Pip install "readMeai [أنثروبور ، google-generativeai]"

؟ تشغيل CLI

1. إعداد متغيرات البيئة

مع Openai:

 ❯ تصدير openai_api_key = <your_api_key># أو لمستخدمي Windows: ❯ تعيين Openai_api_key = <your_api_key>
مقدمي خدمات إضافية (Ollama ، الإنسان ، Google Gemini)
أولاما

ارجع إلى وثائق Ollama لمزيد من المعلومات حول إعداد ALPI Ollama. هنا مثال أساسي:

  1. اسحب النموذج المفضل لديك من مستودع Ollama:

     ❯ Ollama سحب MISTRAL: الأحدث

  2. ابدأ خادم Ollama وقم بتعيين متغير بيئة OLLAMA_HOST :

     ❯ تصدير Ollama_host = 127.0.0.1 && Ollama يخدم
الإنسان

  1. قم بتصدير مفتاح واجهة برمجة تطبيقات الأنثروبور:

     ❯ تصدير anthropic_api_key = <your_api_key>
جوجل الجوزاء

  1. تصدير مفتاح Google Gemini API:

     ❯ تصدير google_api_key = <your_api_key

2. قم بإنشاء readme

قم بتشغيل الأمر التالي ، واستبدال عنوان URL المستودع الخاص بك:

 ❯ readmeai-repository https://github.com/eli64s/readme-ai-api openai

مهم

بشكل افتراضي ، يتم استخدام نموذج gpt-3.5-turbo . قد يتم تكبد التكاليف المرتفعة عند نماذج أكثر تقدماً.

قم بالتشغيل مع Ollama ووضع llama3 كنموذج:

 ❯ readmeai-api ollama-model llama3-repository https://github.com/eli64s/readme-ai

الجري مع Anthropic :

 ❯ readmeai-api أنثروبري -M Claude-3-5-Sonnet-20240620 -r https://github.com/eli64s/readme-ai

تشغيل مع Google Gemini :

 ❯ readmeai-api gemini -m gemini-1.5-flash -r https://github.com/eli64s/readme-ai

استخدم مسار الدليل local :

 readMeai -repository/path/to/your/project

أضف المزيد من خيارات التخصيص:

 ❯ readmeai-repository https://github.com/eli64s/readme-ai
            -output readmeai.md
            -api openai
            -نموذج GPT-4
            -Badge-Color A931ec
            -مربع مسطح على غرار البادج
            -مضغوط على غرار الرأس
            -طية على غرار
            -درجة الحرارة 0.9
            -TREE-DEPTH 2
           -صورة LLM
            -emojis

عامل ميناء

قم بتشغيل حاوية Docker مع عميل Openai:

 ❯ Docker Run -it -RM
     -e openai_api_key = $ openai_api_key
     -V "$ (PWD)":/APP Zeroxeli/README-AI: الأحدث
     -repository https://github.com/eli64s/readme-ai
     -api openai

من المصدر

انقر لتوسيع التعليمات

سحق

إذا قمت بتثبيت المشروع من المصدر باستخدام البرنامج النصي Bash ، فتشغيل الأمر التالي:

  1. تنشيط البيئة الافتراضية:

     conda تنشط readMeai

  2. قم بتشغيل CLI:

     ❯ Python3 -M readmeai.cli.main -r https://github.com/eli64s/readme-ai

شِعر

  1. تنشيط البيئة الافتراضية:

     ❯ قذيفة الشعر

  2. قم بتشغيل CLI:

     ❯ Poetry Run Python3 -M readmeai.cli.main -r https://github.com/eli64s/readme-ai

التدفق

جرب README-AAI مباشرة في متصفحك ، لا مطلوب للتثبيت. راجع مستودع README-AAI-Streamlit لمزيد من التفاصيل.


الاختبار

يتم استخدام أطر عمل Pytest و Nox للتطوير والاختبار.

تثبيت التبعيات باستخدام الشعر:

 ❯ تثبيت الشعر -مع dev ، اختبار

قم بتشغيل جناح اختبار الوحدة باستخدام Pytest:

 ❯ اجعل الاختبار

قم بتشغيل جناح الاختبار ضد Python 3.9 و 3.10 و 3.11 و 3.12 باستخدام أكاسيد النيتروجين:

 ❯ اجعل اختبار nox

نصيحة

Nox هي أداة أتمتة تعمل على أتمتة الاختبار في بيئات Python متعددة. يتم استخدامه لضمان التوافق عبر إصدارات Python المختلفة.

إعدادات

تخصيص جيل ReadMe باستخدام خيارات CLI هذه:

خيار وصف تقصير
--align محاذاة النص في الرأس center
--api مزود خدمة API LLM offline
--badge-color اسم لون الشارة أو رمز السداسي 0080ff
--badge-style نوع نمط أيقونة الشارة flat
--header-style نمط قالب رأس classic
--toc-style نمط جدول المحتويات bullet
--emojis يضيف الرموز التعبيرية إلى أقسام رأس ReadMe False
--image صورة شعار المشروع blue
--model نموذج LLM محدد للاستخدام gpt-3.5-turbo
--output اسم ملف الإخراج readme-ai.md
--repository عنوان URL للمستودع أو مسار الدليل المحلي None
--temperature مستوى الإبداع لتوليد المحتوى 0.1
--tree-depth أقصى عمق لهيكل شجرة الدليل 2

قم بتشغيل الأمر التالي لعرض جميع الخيارات المتاحة:

 ❯ readmeai -help

تفضل بزيارة الوثائق الرسمية للحصول على معلومات أكثر تفصيلاً حول خيارات التكوين والأمثلة وأفضل الممارسات.

أمثلة

عرض مثال ملفات ReadMe التي تم إنشاؤها بواسطة README-AI عبر مداخن التكنولوجيا المختلفة:

تكنولوجيا مثال الإخراج مستودع وصف
readme-ai readme-ai.md readme-ai مشروع readme-ai
Apache Flink readme-pyflink.md Pyflink-Poc مشروع Pyflink
التدفق readme-streamlit.md ReadMe-Ai-Streamlit STERMILIT WEB APP
Vercel & NPM ReadMe-Vercel.md Github-Readme-Quotes نشر Vercel
Go & Docker readme-docker-go.md Docker-GS-Ping تطبيق GO Dockerized
fastapi و redis readme-fastapi-redis.md المؤتمر غير المتزامن خدمة الاستدلال غير المتزامنة ML
جافا readme-java.md الحد الأدنى تطبيق TODO Java الحد الأدنى
PostgreSql & DuckDB readme-postgres.md بوينافيستا Postgres Proxy Server
كوتلين readme-kotlin.md Android-Client تطبيق عميل Android
وضع عدم الاتصال دون اتصال بالإنترنت litellm LLM API Service

ابحث عن أمثلة ReadMe إضافية في دليل الأمثلة.

خريطة الطريق

  • قم بإصدار readmeai 1.0.0 مع ميزات إدارة الوثائق المحسنة.

  • قم بتطوير Vscode Extension لإنشاء ملفات ReadMe مباشرة في المحرر.

  • تطوير GitHub Actions لأتمتة تحديثات الوثائق.

  • أضف badge packs لتوفير أنماط وخيارات شارة إضافية.

    • تغطية الكود ، حالة CI/CD ، إصدار المشروع ، وأكثر من ذلك.

المساهمة

المساهمات مرحب بها! يرجى قراءة الدليل المساهم للبدء.

  • دليل المساهمة : تعرف على عملية المساهمة ومعايير الترميز.

  • ؟ الإبلاغ عن مشكلة : هل وجدت خطأ؟ دعنا نعرف!

  • ابدأ مناقشة : هل لديك أفكار أو اقتراحات؟ نود أن نسمع منك.



شكر وتقدير

  • Shields.io

  • أيقونات بسيطة

  • Aveek-saha/github-profge-badges

  • ileriayo/badges markdown

  • tandpfun/مهارة

رخصة

حقوق الطبع والنشر © 2023 README-AI.
صدر تحت رخصة معهد ماساتشوستس للتكنولوجيا.
يوسع
معلومات إضافية
تطبيقات ذات صلة
نوصي لك
أخبار ذات صلة الكل