check_reqs

第一步

初始化你的代码

1. 在repo中初始化 git

cd check_reqs && git init

2. 如果没有安装 Poetry，运行

make poetry-download

3. 初始化poetry并安装 pre-commit 钩子

make install
make pre-commit-install

4. 运行代码风格检查

make codestyle

5. 将初始代码上传到GitHub

git add .
git commit -m ":tada: Initial commit"
git branch -M main
git remote add origin https://github.com/renefritze/check_reqs.git
git push -u origin main

设置机器人

• 设置 Dependabot 以确保你有最新的依赖项。
• 设置 Stale bot 以自动关闭问题。

Poetry

想了解更多关于Poetry的信息？查看 其文档。

构建和发布你的包

构建应用程序的新版本包含以下步骤

• 将您的包版本提升至 poetry version <version>。您可以显式传递新版本，或者使用如 major、minor 或 patch 这样的规则。更多详情，请参阅语义版本标准。
• 在 GitHub 上提交一个合并请求。
• 创建一个 GitHub release。
• 然后...发布 😊 poetry publish --build

🎯 下一步是什么

这取决于您 💪🏻。我只能推荐帮助过我的包和文章。

• Typer 是创建 CLI 应用程序的好工具。
• Rich 使得在终端中添加美观的格式化变得简单。
• Pydantic – 使用 Python 类型提示进行数据验证和设置管理。
• Loguru 使得日志记录（愚蠢地）变得简单。
• tqdm – Python 和 CLI 的快速、可扩展的进度条。
• IceCream 是一个用于甜美而顺滑的调试的小型库。
• orjson – 超快 JSON 解析库。
• Returns 使您函数的输出有意义、类型化且安全！
• Hydra 是一个用于优雅配置复杂应用的框架。
• FastAPI 是一个类型驱动的异步 Web 框架。

文章

• 开源指南.
• 开源财务支持实用指南
• GitHub Actions 文档.
• 您可能想将 gitmoji 添加到提交名称中。这非常有趣。 😄

🚀 特性

开发特性

• 支持 Python 3.7 及以上版本。
• Poetry 作为依赖项管理器。请参阅 pyproject.toml 和 setup.cfg 中的配置。
• 使用 black、isort 和 pyupgrade 进行自动代码风格。
• 提供带有代码格式化的 pre-commit 钩子。
• 使用 mypy 进行类型检查；使用 darglint 进行文档字符串检查；使用 safety 和 bandit 进行安全检查。
• 使用 pytest 进行测试。
• 提供现成的 .editorconfig、.dockerignore 和 .gitignore。您无需担心这些事情。

部署特性

• 集成 GitHub：问题报告和 pull request 模板。
• 使用预定义的 构建工作流程 作为默认的 CI/CD，使用 Github Actions。
• 使用 Makefile，一切已为您设置好，包括安全检查、代码风格检查、代码格式化、测试、linting、Docker 构建等。更多详情请参阅 makefile-usage。
• 为您的包提供 Dockerfile。
• 使用 @dependabot 确保所有依赖项始终是最新的。您只需 启用它 即可。
• 使用 Release Drafter 自动创建新版本的草稿。您可以在 release-drafter.yml 中查看标签列表。与 语义化版本 规范完美兼容。

开源社区特性

• 可直接使用的 拉取请求模板 和多个 问题模板。
• 自动生成如 LICENSE、CONTRIBUTING.md、CODE_OF_CONDUCT.md 和 SECURITY.md 等文件。
• Stale bot，在一段时间无活跃后关闭废弃的问题。 (您只需要 设置免费计划 即可)。配置在此处 。
• 与 Release Drafter 的 语义化版本 规范。

安装

pip install -U check_reqs

或使用 Poetry 安装

poetry add check_reqs

然后您可以运行

check_reqs --help

或使用 Poetry

poetry run check_reqs --help

Makefile 使用方法

Makefile 包含许多用于快速开发的函数。

make poetry-download

make poetry-remove

make install

make pre-commit-install

make codestyle

# or use synonym
make formatting

make check-codestyle

make update-dev-deps

make check-safety

make check-safety

make mypy

make test

make lint

make test && make check-codestyle && make mypy && make check-safety

make docker-build

make docker-build VERSION=latest

make docker-remove

make pycache-remove

make build-remove

make dsstore-remove

make mypycache-remove

make cleanup

📈 发布

您可以在 GitHub 发布页面 上查看可用发布的列表。

我们遵循 语义化版本 规范。

我们使用 Release Drafter。随着拉取请求的合并，草稿发布将保持最新，列出更改，您准备好发布时即可发布。使用分类选项，您可以使用标签将拉取请求分类到发布说明中。

标签及其对应标题列表

您可以在 release-drafter.yml 中更新它。

GitHub 为您创建了 bug、enhancement 和 documentation 标签。Dependabot 创建 dependencies 标签。当您需要时，在 GitHub 仓库的“问题”选项卡上创建剩余的标签。

🛡 许可证

本项目根据 MIT 许可证授权。有关详细信息，请参阅 LICENSE。

📃 引用

@misc{check_reqs,
  author = {renefritze},
  title = {Checks if all requirements from a file are installed in the current Python env},
  year = {2021},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/renefritze/check_reqs}}
}

感谢

本项目使用 python-package-template 生成。