优秀的`np_data_validator_2`是一个使用https://github.com/TezRomacH/python-package-template创建的Python cli/package
项目描述
np_data_validator_2
优秀的np_data_validator_2
是一个使用https://github.com/TezRomacH/python-package-template创建的Python cli/package
非常初步的步骤
初始化您的代码
- 在您的仓库中初始化
git
cd np_data_validator_2 && git init
- 如果您还没有安装
Poetry
,请运行
make poetry-download
- 初始化 poetry 并安装
pre-commit
钩子
make install
make pre-commit-install
- 运行代码风格检查
make codestyle
- 将初始代码上传到 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 的详细信息
Poetry的命令非常直观且易于学习,例如
poetry add numpy@latest
poetry run pytest
poetry publish --build
等
构建和发布您的包
构建应用程序的新版本包含以下步骤
- 增加您包的版本
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
包含许多用于快速开发的函数。
1. 下载并移除Poetry
要下载和安装Poetry,请运行
make poetry-download
卸载
make poetry-remove
2. 安装所有依赖和预提交钩子
安装需求
make install
在git init
后,可以通过以下方式安装预提交钩子
make pre-commit-install
3. 代码风格
自动格式化使用pyupgrade
、isort
和black
。
make codestyle
# or use synonym
make formatting
代码风格检查,但不重写文件
make check-codestyle
注意:
check-codestyle
使用isort
、black
和darglint
库
使用一条命令更新所有开发库到最新版本
make update-dev-deps
4. 代码安全性
make check-safety
此命令启动Poetry
完整性检查,并使用Safety
和Bandit
识别安全漏洞。
make check-safety
5. 类型检查
运行mypy
静态类型检查器
make mypy
6. 带覆盖率徽章的测试
运行pytest
make test
7. 所有linters
当然,有一个命令可以一次运行所有linters
make lint
等同于
make test && make check-codestyle && make mypy && make check-safety
8. Docker
make docker-build
这等同于
make docker-build VERSION=latest
使用以下命令删除docker镜像
make docker-remove
关于docker的更多信息,请参阅此处。
9. 清理
删除pycache文件
make pycache-remove
移除包构建
make build-remove
删除.DS_STORE文件
make dsstore-remove
移除.mypycache
make mypycache-remove
或者运行以下命令移除所有以上内容
make cleanup
📈 发布
您可以在GitHub发布页面上查看可用的发布列表。
我们遵循语义版本规范。
我们使用Release Drafter
。随着拉取请求的合并,草稿发布会保持更新,列出更改,准备好发布。使用类别选项,您可以使用标签将拉取请求分类到发布说明中。
标签和相应标题的列表
标签 | 发布中的标题 |
---|---|
enhancement 、feature |
🚀 特点 |
bug 、refactoring 、bugfix 、fix |
🔧 修复和重构 |
build 、ci 、testing |
📦 构建系统和CI/CD |
breaking |
💥 破坏性变更 |
documentation |
📝 文档 |
dependencies |
⬆️ 依赖项更新 |
您可以在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
生成
项目详情
下载文件
下载适用于您平台的文件。如果您不确定选择哪个,请了解更多关于 安装包 的信息。
源代码分发
构建分发
np_data_validator_2-0.1.26.tar.gz 的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | 537e851b06e36c99607eb0cfb190cee1321212ed5820ca3b31b06489efdd3933 |
|
MD5 | 8d7776dbf94aa1429fc08f238238b5a3 |
|
BLAKE2b-256 | 3c72aaf55b202fa2984dad9c124ce859df10afa01f0fe6a0fd267be67c1c6122 |
np_data_validator_2-0.1.26-py3-none-any.whl 的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | ddc048df5aff537196581e8d5a34772dcc856c9663a4c2c43cc24c5d3d3eeb9e |
|
MD5 | 7274dfbcfbc13a91062322f368756055 |
|
BLAKE2b-256 | 053a5de5e57429bff04e3412691a33073b59ad5b75dc96bac0cbfa3b760b0f7a |