painy

ألم

 Comments for this repository commits are written with Painy itself.

نجم المستودع لدعم المشروع.

سمات

• Painy هي أداة بسيطة تتيح لك إنشاء رسائل ملزمة تلقائيًا بمساعدة نماذج Openai. يقوم تلقائيًا بالتحقق من التغييرات المرحلية في مستودعك وإنشاء رسالة ارتكاب بناءً على التغييرات.

• يعمل بشكل جيد مع دفاتر Jupyter (ملفات .ipynb ) باستخدام nbdime للانتشار.

• Painy قادر على مراجعة الالتزامات الماضية وإنشاء تلك الجديدة التي تتبع نفس النمط.

• يمكنك إضافة القواعد/الطلبات الخاصة بك كمطالبات إضافية للنموذج. على سبيل المثال ، حدد الحد الأقصى لعدد الأحرف/الجمل في رسالة الالتزام.

• الوضع التفاعلي.

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

• مفتاح API Openai. يمكنك الحصول على واحدة هنا.

• بيثون 3.7.1 أو أعلى ومدير حزمة pip .

تثبيت

• قم بتثبيت الحزمة عبر PIP:

  pip install painy

• اضبط متغير البيئة OPENAI_API_KEY على مفتاح Openai API الخاص بك.

• بشكل افتراضي ، ستستخدم Painy gpt-3.5-turbo (ChatGPT) ، إذا كنت ترغب في استخدام نموذج مختلف ، فقم بتعيين متغير البيئة OPENAI_MODEL_NAME على النموذج الذي تريد استخدامه. يجب أن يكون لديك إمكانية الوصول إلى النموذج الذي تريد استخدامه.

• يعتمد طول سياق الحد الأقصى على النموذج الذي تستخدمه. حاول استخدام الأداة في التغييرات التي لا تكون كبيرة جدًا ، بشكل مثالي على ملف واحد.

الاستخدام

• (موصى به) انتقل إلى المجلد مع مستودعك وقم بتشغيل الأمر التالي:

  • أضف شيئًا إلى المسرح:

    git add < files >

  • ثم استخدم الألم:

    painy comment

  • أو مع متغير البيئة OPENAI_API_KEY في المكان:

    OPENAI_API_KEY= < your-openai-api-key > painy comment

    سيؤدي ذلك إلى إنشاء رسالة ارتكاب بناءً على التغييرات المرحلية في مستودعك.

• ارتكاب تغييرات مروطة مع رسالة التزام تم إنشاؤها:

painy commit

• الوضع التفاعلي:

painy < comment | commit > -i

سيؤدي ذلك إلى إنشاء رسالة ملزمة بناءً على التغييرات المرحلية في مستودعك وسوف تسألك عما إذا كنت ترغب في تجديد رسالة الالتزام.

• إذا كنت ترغب في إنشاء رسالة ملزمة لجميع التغييرات في المستودع الخاص بك ، فتشغيل الأمر التالي (يجب تسجيل هذه الملفات في GIT من قبل من أجل الحصول على فرق للمقارنة):

painy < comment | commit > --check-all

• بشكل افتراضي ، تم تعيين use_commit_history_style على True . إذا كنت ترغب في تعطيله ، قم بتشغيل الأمر التالي:

  painy config --set use-commit-history-style False

• للحصول على القيمة الفعلية لخيار التكوين ، قم بتشغيل الأمر التالي:

  painy config --get use-commit-history-style

• قائمة الخيارات:

  • use_commit_history_style - ما إذا كان يجب استخدام نمط الأول يرتكز في المستودع. بشكل افتراضي تم تعيينه على false . (تجريبي)
  • max_num_commits_style - الحد الأقصى لعدد آخر من الالتزامات الأخيرة لاستخدامه في النمط. بشكل افتراضي تم تعيينه على 5 .
  • max_characters (يستخدم كخاصية في واحدة من القواعد الافتراضية) - الحد الأقصى لعدد الأحرف المطلوب في رسالة الالتزام. بشكل افتراضي تم تعيينه على 100 .

• للحصول على قائمة القواعد ، قم بتشغيل الأمر التالي:

  painy rules

  • لإضافة قاعدة جديدة قم بتشغيل الأمر التالي:

    painy rules --add " Your own rule "

  • لإزالة القاعدة i-th من القائمة قم بتشغيل الأمر التالي:

    painy rules --remove < i >