py-vibracore

CEMS VibraCore web-API的公共Python SDK

此仓库由CEMS BV创建，并是一个围绕CEMS VibraCore web-API的公共Python包装器。

安装

要安装此仓库中的软件包，请运行

$ pip install py-vibracore

环境变量

要使用py-vibracore，请将以下环境变量添加到您的环境中。或者在被询问时提供它们。

* NUCLEI_TOKEN
    - Your NUCLEI user token

您可以在NUCLEI上获取您的NUCLEI_TOKEN。转到personal-access-tokens并创建一个新的用户令牌。

贡献

环境

我们建议使用Python3.9和一个干净的虚拟环境（使用virtualenv或conda）进行开发，从requirements.txt文件中安装要求

使用virtualenv和pip在Linux上安装新环境.env中的依赖关系的示例

python -m venv .env
source .env/bin/activate
python -m pip install --upgrade pip setuptools
pip install -r requirements.txt
pip install -e .

文档

构建文档

python -m pip install --upgrade pip setuptools
pip install -r requirements.txt
pip install .

sphinx-build -b html docs public

格式

我们使用black和isort格式化我们的代码。

black --config "pyproject.toml" src/pyvibracore tests notebooks
isort --settings-path "pyproject.toml" src/pyvibracore tests notebooks

代码审查

为了保持代码质量，我们使用GitHub super-linter。

要本地运行审查器，请从根目录运行run_super_linters.sh bash脚本。

单元测试

使用coverage测试软件

python -m pip install --upgrade pip setuptools
pip install -r requirements.txt
pip install -e .
coverage run -m pytest

要求

要求由python 3.9的pip-compile命令自动生成

使用以下内容安装pip-tools

pip install pip-tools

使用以下内容生成requirements.txt文件

pip-compile --extra=test --extra=lint --extra=docs --extra=notebook --output-file=requirements.txt pyproject.toml

使用以下内容在定义的范围内更新要求

pip-compile --upgrade --extra=test --extra=lint --extra=docs --extra=notebook --output-file=requirements.txt pyproject.toml