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 许可条款获得许可。