bootstrap python package

Bootstrap-python-package

Repositori template ini menyediakan boilerplate untuk membuat paket python. Ini dikonfigurasi dengan semua fitur berikut:

• Test Suite menggunakan TOX dan PYTEST
• Mengetik menggunakan mypy
• Format serat, keamanan dan kode menggunakan ruff (menggunakan gaya kode hitam dan aturan keamanan bandit)
• Integrasi dengan Codeclimate untuk Kualitas Kode dan Pemeriksaan Cakupan
• Pipa CI mendukung:
  • pengujian terhadap beberapa versi Python
  • Rilis di PYPI
  • Dokumentasi halaman github menggunakan mkdocs
• Konfigurasi Dasar Profil Pycharm

Cara menggunakan template repositori ini untuk membuat paket baru

• Buat repositori GitHub Anda menggunakan template ini. (Big Green Use this template )
• Ganti nama direktori bootstrap_python_package
• Cari dan ganti semua kemunculan bootstrap-python-package dan bootstrap_python_package
• Konfigurasikan penerbit tepercaya yang tertunda di PYPI menggunakan nilai -nilai berikut:
  • Nama Proyek PYPI: Nama Repositori GitHub (dalam hal ini bootstrap-python-package )
  • Pemilik: Pemilik Repositori GitHub (dalam hal ini febus982 )
  • Nama Repositori: Nama Repositori GitHub (dalam hal ini bootstrap-python-package )
  • Nama Alur Kerja: release.yml
• Buat Tindakan GitHub Rahasia bernama CODECLIMATE_REPORTER_ID (di url https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/secrets/actions ) yang berisi id reporter codecliming (Anda dapat menemukannya di https://codeclimate.com/repos/YOUR_REPO_ID/settings/test_reporter ). Jika Anda tidak ingin menggunakan codeclimate, hapus workflows/python-quality.yml .
• Perbarui lencana di README.md ! (Periksa Shields.io untuk lencana tambahan)
• Perbarui Profil Hak Cipta Pycharm di Pengaturan IDE: Editor | Hak Cipta | Profil Hak Cipta (jika Anda ingin menggunakannya)
• Mengatur Pengembangan Lokal:
  • Klon Repositori
  • Instal Puisi pip install poetry
  • Instal dependensi dev dengan make dev-dependencies
  • (Opsional) Sangat disarankan untuk menginstal pra-berkomitmen dan menjalankan pre-commit install sehingga pemformatan dan linting secara otomatis dieksekusi selama git commit .
• Pengaturan Halaman GitHub (Ini Perlu Pengaturan Pengembangan Lokal):
  • Inisialisasi Dokumentasi Cabang poetry run mike deploy dev latest --update-aliases --push
  • Konfigurasikan halaman github untuk digunakan dari cabang gh-pages (di url https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/pages )
  • Tambahkan Cabang main dan v*.*.* Tag Aturan ke daftar "Deployment Branch and Tags" di lingkungan gh-pages (di URL https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/environments )

Penting: Repositori dikonfigurasi untuk digunakan pada repositori PYPI uji. Sangat disarankan untuk membuat proyek dalam repositori PYPI uji dan menguji pipa penempatan. Saat Anda senang dengan hasilnya, buat proyek di repositori PYPI resmi dan hapus garis yang ditandai dalam workflows/release.yml .

Rilis paket

Pengaturan ini menggunakan puisi-dinamis-versi. Ini berarti tidak perlu melakukan versi dalam kode tetapi pipa CI akan menyimpulkannya dari tag Git.

Untuk merilis versi baru, cukup buat rilis dan tag baru di repositori GitHub, untuk:

• Bangun dan gunakan paket Python ke PYPI
• Bangun dan sebarkan versi baru dari dokumentasi ke halaman GitHub

Penting: Konfigurasi default membutuhkan nama rilis dan tag untuk mengikuti konvensi vX.XX (versi semantik yang didahului oleh huruf kecil v ). Ini akan menerbitkan versi yang benar di PYPI, menghilangkan v (yaitu. v1.0.0 akan menerbitkan 1.0.0 ).

Format ini dapat disesuaikan, lihat dokumen puisi-dinamis

Perintah untuk pengembangan

Semua perintah umum yang digunakan selama pengembangan dapat dijalankan menggunakan target membuat:

• make dev-dependencies : Instal Persyaratan Dev
• make update-dependencies : Perbarui Persyaratan Dev
• make fix : Jalankan gaya kode dan perbaikan otomatis serat (jika memungkinkan)
• make test : Jalankan test suite melawan System Python Version
• make check : Jalankan tes terhadap semua versi Python yang tersedia, gaya kode dan cek serat
• make type , make format , make lint , make bandit : jalankan cek yang relevan
• make docs : Render situs web MKDOCS secara lokal