wiutils

wiutils有几个实用程序用于探索和操作（过滤、绘制和汇总）来自Wildlife Insights项目的信息。这些功能可用于计算基本统计数据、准备信息以供进一步分析（例如占用模型）并将其转化为其他标准（例如Darwin Core），以促进其在生物多样性信息中心（例如GBIF）上的发布。

安装

目前，wiutils适用于 Python 版本 3.6 到 3.10。

使用pip：

pip install wiutils

使用conda：

conda install -c conda-forge wiutils

执行

要检查是否安装wiutils成功，请执行以下命令：

python -c "import wiutils"

如果这没有抛出任何错误，则安装成功。

您可以wiutils通过从 Python 控制台或脚本导入包来使用函数。有关可用功能的更多信息，请查看文档。

如何贡献

欢迎大家踊跃投稿wiutils。人们可以为包的开发做出贡献，也可以通过报告潜在的错误来改进文档。

设置

建议使用虚拟环境安装包，以避免篡改系统中的其他 Python 安装。

在您的计算机中克隆此存储库：

git clone https://github.com/PEM-Humboldt/wiutils.git

转到项目的根目录：

cd wiutils

在开发模式下安装包：

pip install --editable .[dev,docs,test]

确保任何新开发都在新分支中完成。完成后，提交拉取请求以合并更改。

单元测试

在项目的根目录中执行以下命令：

pytest tests/

Python 版本

wiutils适用于 Python 3.6 至 3.10 版本。为了确保代码适用于所有这些版本，tox使用。确保您已在系统上安装了这些 Python 版本，然后在项目的根目录中运行以下命令：

tox

这将为每个 Python 版本运行所有单元测试，以确保一切正常。

如果您向项目添加任何新的依赖关系，请确保按如下方式运行 tox 以便它可以重新创建环境：

tox -r

代码覆盖率

我们确保代码覆盖率为 100%。理想情况下，在实现新功能或进行更改时，您应该确保代码覆盖率仍然是 100%。为此，运行测试的覆盖率：

覆盖运行 -m pytest tests/

然后运行报告：

coverage report -m -i

代码风格

我们使用预提交挂钩来确保新更改符合不同的编码准则。你只需要安装这些钩子一次（最好是在进行任何提交之前），通过运行：

pre-commit install

之后，您尝试进行的每次提交都将在提交更改之前运行挂钩。如果挂钩修改了您的更改，您将不得不添加这些文件并再次提交。

作者和贡献者

• 阿德里安娜·雷斯特雷波-伊萨
• 当归迪亚兹-普利多
• Marcelo Villa-Piñeros -马塞洛维拉

执照

该项目在 MIT 许可证下获得许可 - 有关详细信息，请参阅LICENSE.txt文件。