Blaupause - Python软件包模板

Martin Lang¹ 和 Marijan Beg¹

¹ 南安普顿大学工程学院和物理科学学院，南安普顿 SO17 1BJ，英国

描述	徽章
构建
覆盖率
文档
Binder
许可证
DOI

关于

一个基于Python的示例软件包，可用于设置项目的教程。

演示包括

• 使用pytest/doctests进行测试
• 持续集成
  • Travis
  • Appveyor
  • 很快：GitHub actions
• 代码覆盖率
• docker
• make文件
• 打包
• 文档
• 许可

它可在Windows、MacOS和Linux上使用。需要Python 3.8+。

文档

API和教程在文档中提供。要访问它们，请使用上表中的文档徽章。

安装、测试和升级

我们建议使用conda软件包管理器进行安装。说明可以在文档中找到。

Binder

此软件包可以通过Binder在云端使用。要访问Binder，请使用上表中的Binder徽章。

支持

如果您需要支持，有疑问，想报告错误，或想提出改进建议，请在此存储库中提出问题。

许可证

本软件依据BSD 3-Clause "新"或"修订"许可协议授权。有关详情，请参阅LICENSE文件。

如何引用

请按以下方式引用本软件包

Martin Lang 和 Marijan Beg. Blaupause - Python 软件包模板。Zenodo。DOI: 10.5281/zenodo.4327500 (2020)。

致谢

• EPSRC 项目资助《Skyrmionics》项目（EP/N032128/1）。