bootstrap python package

bootstrap-python package

يوفر مستودع القالب هذا الغلاية لإنشاء حزمة بيثون. تم تكوينه مع جميع الميزات التالية:

• اختبار جناح باستخدام Tox و Pytest
• الكتابة باستخدام mypy
• تنسيق Linting والأمان والرمز باستخدام Ruff (باستخدام نمط الرمز الأسود وقواعد أمان Bandit)
• التكامل مع codeclimate لجودة الرمز والتحقق من التغطية
• خط أنابيب CI دعم:
  • الاختبار ضد إصدارات الثعبان المتعددة
  • الإصدارات على PYPI
  • وثائق صفحات Github باستخدام MKDOCS
• تكوين ملف تعريف Pycharm الأساسي

كيفية استخدام قالب المستودع هذا لإنشاء حزمة جديدة

• قم بإنشاء مستودع GitHub باستخدام هذا القالب. (الزر الأخضر الكبير Use this template )
• أعد تسمية دليل bootstrap_python_package
• ابحث واستبدال جميع حوادث bootstrap-python-package و bootstrap_python_package
• قم بتكوين ناشر موثوق به على PYPI باستخدام القيم التالية:
  • اسم مشروع PYPI: اسم مستودع Github (في هذه الحالة bootstrap-python-package )
  • المالك: مالك مستودع GitHub (في هذه الحالة febus982 )
  • اسم المستودع: اسم مستودع Github (في هذه الحالة bootstrap-python-package )
  • اسم سير العمل: release.yml
• قم بإنشاء سرية لإجراءات github اسم CODECLIMATE_REPORTER_ID (في url https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/secrets/actions ) التي تحتوي https://codeclimate.com/repos/YOUR_REPO_ID/settings/test_reporter ). إذا كنت لا ترغب في استخدام codeclimate ، فما عليك سوى حذف workflows/python-quality.yml .
• تحديث الشارات في README.md ! (تحقق من shields.io للحصول على شارات إضافية)
• قم بتحديث ملف تعريف حقوق الطبع والنشر لـ Pycharm في إعدادات IDE: محرر | حقوق الطبع والنشر | ملامح حقوق الطبع والنشر (إذا كنت تريد استخدامه)
• إعداد التنمية المحلية:
  • استنساخ المستودع
  • تثبيت الشعر pip install poetry
  • تثبيت تبعية DEV مع make dev-dependencies
  • (اختياري) ينصح بشدة بتثبيت التثبيت قبل الالتزام وتشغيل pre-commit install بحيث يتم تنفيذ التنسيق والتنظيم تلقائيًا أثناء git commit .
• إعداد صفحات github (هذا الحاجة إلى إعداد التنمية المحلية):
  • تهيئة poetry run mike deploy dev latest --update-aliases --push
  • قم بتكوين صفحات github للنشر من فرع gh-pages (في url https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/pages )
  • أضف الفرع main و v*.*.* gh-pages https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/environments

هام: تم تكوين المستودع للنشر على مستودع اختبار PYPI. يوصى بشدة بإنشاء المشروع في مستودع اختبار PYPI واختبار خط أنابيب النشر. عندما تكون راضيًا عن النتيجة ، قم بإنشاء المشروع على مستودع PYPI الرسمي وقم بإزالة الخطوط المحددة في workflows/release.yml .

إصدار الحزمة

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

لإصدار إصدار جديد ، ما عليك سوى إنشاء إصدار جديد وعلامة في مستودع GitHub ، إلى:

• بناء ونشر حزمة Python إلى Pypi
• قم ببناء ونشر نسخة جديدة من الوثائق إلى صفحات github

هام: يتطلب التكوين الافتراضي اسم الإصدار والعلامة لمتابعة الاتفاقية vX.XX (الإصدار الدلالي الذي يسبقه Lopcase v ). سوف تنشر الإصدار الصحيح على PYPI ، مع حذف v (أي v1.0.0 سوف ينشر 1.0.0 ).

يمكن تخصيص هذا التنسيق ، والرجوع إلى مستندات تصحيح الشعر الديني الديناميكي

أوامر للتنمية

يمكن تشغيل جميع الأوامر المشتركة المستخدمة أثناء التطوير باستخدام أهداف جعل:

• make dev-dependencies : تثبيت متطلبات DEV
• make update-dependencies : تحديث متطلبات DEV
• make fix : قم بتشغيل نمط الرمز والإصلاحات التلقائية للنيصة (حيثما أمكن)
• make test : قم بتشغيل جناح الاختبار مقابل إصدار Python System
• make check : قم بإجراء اختبارات مقابل جميع إصدارات Python المتاحة ، ونمط الرمز والشيكات الوبر
• make type ، make format ، make lint ، make bandit : قم بتشغيل الشيكات ذات الصلة
• make docs : جعل موقع MKDOCS محليًا