主题指南

这里的页面面向正在开发或维护软件包的开发者,他们希望遵循 Python 的现代最佳实践。

鼓励新开发者阅读以下页面。资深开发者仍然应该查看 教程,因为它包含有关 CONTRIBUTING.md 建议的指南,并且至少应该浏览其他部分。

之后,有一些关于 样式 的建议,旨在促进良好实践并确保软件包之间的连续性。有一个关于 使用 MyPy 进行静态类型检查的专门页面。然后是关于 简单打包编译打包,甚至 经典打包 的指南,这些指南应该有助于确保在处理分发时一致的开发者和用户体验。

接下来是关于 CI 的部分,其中包含一个 通用设置指南,然后是两种使用 CI 分发软件包的选择,一种针对 纯 Python,另一种针对 编译扩展。您可以在 pytest 页面 上阅读关于设置良好测试的信息,并附带 覆盖率。还有一个关于设置 文档 的页面。

新项目模板

完成指南后,有一个 copier/cookiecutter/cruft 项目,scientific-python/cookie,它实现了这些指南,并允许您在不到 60 秒的时间内从模板设置一个新软件包!九个构建后端,包括编译后端,在 Nox 中生成测试,并与指南保持同步。

检查现有项目

我们提供 sp-repo-review,一组用于将您的代码库与指南进行比较的 repo-review 检查,可通过 WebAssembly 在 指南中直接运行!所有检查都指向指南中的链接徽章。


目录