cookiecutter hatch pypackage

cookiecutter hatch pypackage

Templat Cookiecutter untuk paket Python mutakhir: Hatch , ruff , mypy , GitHub Actions , dan banyak lagi!

Detail
Fitur

Fitur

• Pemula yang ringan
• Manajemen paket Hatch
• hatch-vcs: menentukan versi paket secara otomatis dari git tag, misalnya v0.9
• Linting dan format dengan ruff yang menggantikan isort, flake8, black, dll.
• Ketik pemeriksaan dengan mypy
• Periksa dependensi yang tidak digunakan, hilang, dan transitif dengan deptry
• Pengujian unit dengan pytest dengan pengaturan asyncio opsional.
• Otomatiskan dan standarisasi pengujian dengan matriks Hatch-env
• Dokumentasi dengan Materi untuk MkDocs dan dukungan referensi docstring dengan mkdocstrings.
• Pipeline GitHub Actions yang siap digunakan dengan dependabot , release-drafter , labeler , publish to PYPI workflows , publish to test PYPI workflows & banyak lagi.
• hatch-pip-compile: dukungan eksperimental untuk file kunci,
• pyproject.toml: semua konfigurasi paket, build, dan alat dalam satu file,
• cakupan: alat untuk mengukur cakupan kode program Python dengan integrasi pytest,
• pra-komit: kait git pra-komit yang membuat hidup Anda lebih mudah,
• Penurunan harga: alih-alih reStructuredText, Penurunan harga digunakan secara konsisten untuk semua file teks,
• EditorConfig: pertahankan gaya pengkodean yang konsisten untuk banyak pengembang,
• src-layout: paket Python sebenarnya disimpan di bawah folder src untuk menghindari banyak kesalahan umum.

? Mulai cepat

Hasilkan proyek:

Proyek ini akan menggunakan pipx untuk memasang hatch di lingkungan yang terisolasi. Pastikan Anda telah menginstal pipx sebelum menjalankan perintah berikut.

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

Generator akan secara otomatis memanggil hatch env create & git init di akhir.

Kemudian, agar GitHub Actions pipelines berfungsi dengan benar, Anda harus:

• Aktifkan repositori GitHub di Codecov .
• Tetapkan CODECOV_TOKEN di rahasia repositori GitHub Anda. Anda dapat menemukannya di pengaturan Codecov dari proyek yang sesuai.
• Aktifkan GitHub Pages menggunakan sumber GitHub Actions .
• Opsi untuk mempublikasikan ke Test PyPI untuk pengujian.
• Konfigurasikan metode Penerbit Tepercaya di PyPI: ini adalah metode modern dan aman untuk mendorong paket Anda ke PyPI.

Dengan kasar

cruft adalah lapisan di atas Cookiecutter yang memungkinkan Anda memperbarui proyek Anda dari templat setelah dibuat.

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

Demo

Lisensi

Proyek ini dilisensikan berdasarkan ketentuan lisensi MIT.