:cookie: cookie-doh

Cookie-doh是一个用于创建包含预配置开发工具的单个Python包项目的存储库模板。

:woman_shrugging: 我为什么要关心？

• :seedling: 提高个人和协作项目的开发工作流程、代码的有效性和可读性！

• :scroll: 使用poetry进行依赖项管理、虚拟环境和打包，即代码易于导入！

• :tropical_drink: 创建一个完全预配置的项目只需不到一分钟！

:link: 短链接: https://aka.ms/cookie-doh

:star: 星标此存储库以显示您的支持！

:rocket: 使用cookie-doh入门

此模板使用copier创建新的存储库。如果您没有copier，请按照安装说明操作。

然后，只需键入

copier copy gh:microsoft/cookie-doh <new-repo-folder>

并回答问题以创建您的新项目。

最低必需系统依赖项是python >= 3.10和poetry。

:notebook_with_decorative_cover: 文档

访问文档

https://msdocs.cn/cookie-doh/

:point_right: 前往新项目开始！

:space_invader: Codespaces

我们为您提供配置了devcontainer的新项目以及cookie-doh本身。您可以使用包含所有必需依赖项的容器镜像，并使用它通过GitHub Codespaces或DevPod进行远程开发。

:point_right: 点击下面自动克隆或分叉此存储库并开始开发

:gear: Devcontainer

或者，您可以直接在本地构建容器并在VSCode和/或PyCharm中使用它，而无需在远程节点上进行开发或设置本地环境。

了解关于 Devcontainers 的信息。需要在本地机器上安装 Docker。

:point_right: 遵循 VSCode 和/或 PyCharm 的说明。

:computer: 本地开发

所需的最小系统依赖项是 python >= 3.10 和 poetry。然而，我们建议安装一些额外的依赖项以改善开发体验。

:point_right: 遵循 说明 来设置您的本地环境。

:hammer_and_wrench: 开发工具

Cookie-doh 使用以下工具来帮助提高开发体验，并生成项目

• Poetry 用于依赖关系管理、虚拟环境和打包，即使您的代码易于导入！
• ruff 用于格式化和代码检查：帮助您编写干净、统一且一致性更好的代码（而且它很快！）。
• pytest 用于测试：确保您的代码按预期工作！
• pyright 用于静态注释：帮助识别简单错误，更重要的是，使您的代码更具可读性！
• codespell 用于拼写检查：在代码和文档中定位拼写错误。
• CI 工作流：在您提交 PR 或合并到 main 分支时自动进行验证。

可选工具（在创建新项目时使用）

• MkDocs 用于构建美观的 Markdown 文档（例如 cookie-doh 的）。
• pre-commit 用于在提交之前进行快速验证检查和修复。
• commitizen 用于编写 conventional commits，以帮助编写更好的提交信息并通过 时间 跟踪更改。

:mountain: 贡献

此项目欢迎贡献和建议。大多数贡献都需要您同意贡献者许可协议（CLA），声明您有权并且确实授予我们使用您的贡献的权利。有关详细信息，请访问 https://cla.opensource.microsoft.com。

提交拉取请求时，CLA 机器人将自动确定您是否需要提供 CLA，并相应地装饰 PR（例如，状态检查、注释）。只需遵循机器人提供的说明即可。您只需在整个使用我们的 CLA 的所有存储库中做一次。

此项目已采用 Microsoft 开源行为准则。有关更多信息，请参阅 行为准则常见问题解答 或联系 opencode@microsoft.com 了解任何其他问题或意见。

:balance_scale: 商标

此项目可能包含项目、产品或服务的商标或徽标。Microsoft 商标的授权使用必须遵守并遵循 Microsoft 的商标和品牌指南。在修改后的此项目中使用 Microsoft 商标或徽标不得造成混淆或暗示 Microsoft 赞助。任何第三方商标或徽标的使用均受这些第三方政策的约束。