nptk

第一步

初始化您的代码

1. 在您的repo内部初始化git

cd nptk && 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/nptk/nptk.git
git push -u origin main

设置机器人

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

Poetry

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

构建和发布您的软件包

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

• 提高您软件包的版本 poetry version <version>。您可以显式传递新版本，或规则如major、minor或patch。有关更多详细信息，请参阅语义版本标准。
• 对GitHub进行提交。
• 创建GitHub发布。
• 然后...发布吧！poetry publish --build

🎯 下一步是什么

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

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

文章

• 开源指南.
• 开源财务支持实用指南
• GitHub Actions 文档.
• 也许你想要将 gitmoji 添加到提交名称中。这真的很有趣。 😄

🚀 功能

开发功能

• 支持Python 3.9及更高版本。
• Poetry作为依赖关系管理器。请参阅pyproject.toml和setup.cfg中的配置。
• 使用black、isort和pyupgrade自动进行代码风格检查。
• 带有代码格式化的pre-commit钩子。
• 使用mypy进行类型检查；使用darglint进行文档字符串检查；使用safety和bandit进行安全检查。
• 使用pytest进行测试。
• 准备好使用.editorconfig、.dockerignore和.gitignore。你不必担心这些事情。

部署功能

• GitHub集成：问题和pr模板。
• 默认CI/CD为预定义的构建工作流程的GitHub Actions。
• 使用Makefile已经为您设置好了安全检查、代码风格检查、代码格式化、测试、linting、docker构建等（见makefile-usage）。更多详情请参阅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 nptk

或使用Poetry安装

poetry add nptk

然后您可以运行

nptk --help

或使用Poetry

poetry run nptk --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{nptk,
  author = {nptk},
  title = {Awesome `nptk` is a Python cli/package created with https://github.com/TezRomacH/python-package-template},
  year = {2022},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/nptk/nptk}}
}

版权信息

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