cookiecutter hatch pypackage

cookiecutter hatch pypackage

قالب Cookiecutter لحزمة Python المتطورة: Hatch و ruff و mypy و GitHub Actions والمزيد!

تفاصيل
سمات

سمات

• بداية خفيفة الوزن
• إدارة حزمة Hatch
• Hatch-VCS: تحديد إصدار الحزمة تلقائيًا من علامات git، على سبيل المثال v0.9
• البطانة والتنسيق باستخدام ruff الذي يحل محل isort، وflake8، والأسود، وما إلى ذلك.
• اكتب التحقق مع mypy
• تحقق من التبعيات غير المستخدمة والمفقودة والمتعدية باستخدام deptry
• اختبارات الوحدة باستخدام pytest مع الإعداد الاختياري غير المتزامن.
• أتمتة الاختبار وتوحيده باستخدام مصفوفات Hatch-env
• التوثيق باستخدام المواد الخاصة بـ MkDocs ودعم مرجع docstring باستخدام mkdocstrings.
• خطوط أنابيب GitHub Actions جاهزة للاستخدام مع dependabot ، release-drafter ، labeler ، publish to PYPI workflows ، publish to test PYPI workflows والمزيد.
• Hatch-Pip-Compile: دعم تجريبي لملفات القفل،
• pyproject.toml: جميع إعدادات الحزمة والإنشاء والأداة في ملف واحد،
• التغطية: أداة لقياس تغطية التعليمات البرمجية لبرامج بايثون مع تكامل pytest،
• الالتزام المسبق: خطافات git الالتزام المسبق التي تجعل حياتك أسهل،
• Markdown: بدلاً من reStructuredText، يتم استخدام Markdown باستمرار لجميع الملفات النصية.
• EditorConfig: الحفاظ على أنماط ترميز متسقة للعديد من المطورين،
• src-layout: يتم الاحتفاظ بحزمة Python الفعلية ضمن مجلد src لتجنب العديد من الأخطاء الشائعة.

؟ بداية سريعة

إنشاء المشروع:

سيستخدم هذا المشروع pipx لتثبيت hatch في بيئة معزولة. تأكد من تثبيت pipx قبل تشغيل الأمر التالي.

cookiecutter https://github.com/Aviksaikat/cookiecutter-hatch-pypackage

سيقوم المولد تلقائيًا باستدعاء hatch env create & git init في النهاية.

بعد ذلك، لكي تعمل GitHub Actions pipelines بشكل صحيح، يجب عليك:

• تمكين مستودع GitHub في Codecov .
• قم بتعيين CODECOV_TOKEN في أسرار مستودع GitHub الخاص بك. يمكنك العثور على إعدادات Codecov للمشروع المقابل.
• تمكين GitHub Pages باستخدام مصدر GitHub Actions .
• خيار للنشر لاختبار PyPI للاختبار.
• قم بتكوين طريقة Trusted Publisher على PyPI: إنها طريقة حديثة وآمنة لدفع الحزمة الخاصة بك إلى PyPI.

مع كرافت

Cruft عبارة عن طبقة فوق Cookiecutter تسمح لك بتحديث مشروعك من القالب بعد إنشائه.

cruft create https://github.com/Aviksaikat/cookiecutter-hatch-pypackage

تجريبي

رخصة

هذا المشروع مرخص بموجب شروط ترخيص MIT.