初始化您的代码

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

cd np-lims-tk && 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_lims_tk/np-lims-tk.git
git push -u origin main

设置机器人

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

Poetry

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

构建和发布您的包

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

• 提高您包的版本 poetry 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.7 及更高版本。
• 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，一切已经设置好，用于安全检查、代码风格检查、代码格式化、测试、代码检查、Docker 构建等。更多详情请参阅 makefile-usage。
• 为你的包创建 Dockerfile。
• 使用 @dependabot 保持依赖项始终是最新的。你只需要 启用它。
• 使用 Release Drafter 自动创建新版本的草稿。您可以在 release-drafter.yml 中查看标签列表。与 语义版本 规范完美兼容。

开源社区功能

• 可直接使用的 Pull Requests 模板 和几个 Issue 模板。
• 自动生成文件，如：LICENSE、CONTRIBUTING.md、CODE_OF_CONDUCT.md 和 SECURITY.md。
• Stale bot 在一段时间的不活跃后关闭已弃用的 issue。（您只需 设置免费计划）。配置在此处：链接。
• 使用 Release Drafter 和 语义版本 规范。

要下载和安装 Poetry，请运行

make poetry-download

卸载

make poetry-remove

安装要求

make install

在 git init 之后，可以通过以下方式安装 pre-commit 钩子：

make pre-commit-install

自动格式化使用 pyupgrade、isort 和 black。

make codestyle

# or use synonym
make formatting

仅进行代码风格检查，不重写文件

make check-codestyle

注意：check-codestyle 使用 isort、black 和 darglint 库

使用一个命令更新所有开发库到最新版本

make update-dev-deps

make check-safety

make check-safety

运行 mypy 静态类型检查器

make mypy

运行 pytest

make test

当然，有一个命令可以 统一 运行所有代码检查器

make lint

等同于

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

make docker-build

这相当于

make docker-build VERSION=latest

使用以下命令删除 Docker 镜像

make docker-remove

有关 Docker 的更多信息，请参阅 链接。

删除 pycache 文件

make pycache-remove

移除包构建

make build-remove

删除 .DS_STORE 文件

make dsstore-remove

删除 .mypycache

make mypycache-remove

或运行以下命令来删除所有上述文件

make cleanup