pyospackage

pyospackage做什么？

pyospackage是一个演示Python包，它补充了pyOpenSci 关于创建Python包的初学者教程系列。

目录

• 安装
• 许可

如何安装

您可以使用pip或conda-forge安装此包。我们建议您在安装此包时创建一个新的Python环境。使用您想要的任何环境管理器！

使用pip安装包

pip install pyospackage

使用conda-forge安装包

conda install -c conda-forge pyospackage

开始使用packagename

要使用此包

from pyospackage.add_numbers import add_num


a = add_num(1, 2)
print(a)

您还可以将任何链接添加到此部分，以便在文档中的教程中使用。

开发

• 待办事项：当存在开发文档时，链接到开发文档，并将以下文本移动到文档中。

代码检查与代码格式化

待办事项：这将添加到文档中，一旦在单独的pr中创建。

所有代码检查和格式化都使用预提交钩子和Ruff实现，Ruff是一个基于Rust的快速代码检查器和格式化工具，它涵盖了之前由Black和isort（Python生态系统中常用的格式化工具）实现的功能。Ruff简化了您的代码检查和格式化设置，但使用单个工具运行所有检查和修复。因此，pyOpenSci鼓励新项目考虑使用Ruff。

社区

关于为您的包贡献的信息。链接到您的行为准则和开发指南。

如何引用pyospackage

要引用pyospackage，请遵循Zenodo上的引用说明。

Leah Wasser. (2024). pyOpenSci/pyosPackage: v0.1 Test release (v0.1.0). Zenodo. https://doi.org/10.5281/zenodo.10594121

许可

pyospackage 在 MIT 许可协议下分发。

贡献者 ✨

感谢以下杰出人士的贡献 (表情符号键)

Alex Batisse 👀

本项目遵循 all-contributors 规范。欢迎任何形式的贡献！