cookiecutter hatch pypackage

cookiecutter hatch pypackage

尖端 Python 套件的 Cookiecutter 範本： Hatch 、 ruff 、 mypy 、 GitHub Actions等等！

細節
特徵

特徵

• 輕量級啟動器
• Hatch包管理
• hash-vcs：根據git標籤自動決定軟體包版本，例如v0.9
• 用ruff取代 isort、flake8、black 等進行絨毛和格式化。
• 使用mypy進行類型檢查
• 使用deptry檢查未使用的、缺失的和傳遞的依賴項
• 使用pytest和可選的 asyncio 設定進行單元測試。
• 使用 Hatch-env-matrices 自動化和標準化測試
• Material for MkDocs 的文件和 mkdocstrings 的文件字串參考支援。
• 即用型 GitHub Actions 管道，包含dependabot 、 release-drafter 、 labeler 、 publish to PYPI workflows 、 publish to test PYPI workflows等。
• hash-pip-compile：對鎖定檔案的實驗性支持，
• pyproject.toml：所有套件、建置和工具配置都在一個檔案中，
• 覆蓋率：用於透過 pytest 整合測量 Python 程式碼覆蓋率的工具，
• 預先提交：預先提交 git hooks 讓你的生活更輕鬆，
• Markdown：所有文字檔案一致使用 M​​arkdown，而不是 reStructuredText，
• EditorConfig：為多個開發人員保持一致的編碼風格，
• src-layout：實際的 Python 套件保存在src資料夾下，避免了許多常見錯誤。

？快速入門

生成項目：

該專案將使用pipx在隔離環境中安裝hatch 。在執行以下命令之前，請確保您已安裝pipx 。

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

生成器最後會自動呼叫hatch env create & git init 。

然後，為了使GitHub Actions pipelines正常工作，您應該：

• 在Codecov中啟用 GitHub 儲存庫。
• 在 GitHub 儲存庫機密中設定CODECOV_TOKEN 。可以在對應項目的Codecov設定中找到。
• 使用GitHub Actions來源啟用GitHub Pages 。
• 發佈到 Test PyPI進行測試的選項。
• 在 PyPI 上設定受信任的發布者方法：這是一種將套件推送到 PyPI 的現代且安全的方法。

帶著粗俗

cruft 是 Cookiecutter 之上的一層，可讓您在產生項目後從範本更新項目。

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

示範

執照

該項目根據 MIT 許可條款獲得許可。