np_data_validator_2

非常初步的步骤

初始化您的代码

1. 在您的仓库中初始化 git

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

设置机器人

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

Poetry

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

构建和发布您的包

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

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

🎯 下一步是什么

好吧，这取决于你 💪🏻。我只能推荐那些对我有帮助的软件包和文章。

• Typer非常适合创建命令行应用。
• Rich使在终端中添加美观的格式化变得容易。
• Pydantic – 使用Python类型提示进行数据验证和设置管理。
• Loguru使日志记录（非常简单）。
• tqdm – Python和CLI的快速、可扩展的进度条。
• IceCream是一个用于美味奶油调试的小型库。
• orjson – 极快的JSON解析库。
• 使你的函数输出有意义、类型化且安全！
• 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。
• 你的软件包的Dockerfile。
• 使用@dependabot确保依赖项始终是最新的。你只需启用它。
• 使用Release Drafter自动创建新版本的草稿。你可以在release-drafter.yml中查看标签列表。与语义版本规范完美配合。

开源社区特性

• 可直接使用的拉取请求模板和多个问题模板。
• 以下文件会自动生成：LICENSE、CONTRIBUTING.md、CODE_OF_CONDUCT.md和SECURITY.md。
• Stale bot会在一定时间后关闭未活跃的问题。您只需要设置免费计划。（配置在此处）。
• 遵循语义版本规范，使用Release Drafter。

安装

pip install -U np_data_validator_2

或者使用Poetry安装

poetry add np_data_validator_2

然后您可以运行

np_data_validator_2 --help

或者使用Poetry

poetry run np_data_validator_2 --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{np_data_validator_2,
  author = {np_data_validator_2},
  title = {Awesome `np_data_validator_2` 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/np_data_validator_2/np_data_validator_2}}
}

致谢

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