CEMS PileCore web-API的公共Python SDK。
项目描述
py-pilecore
CEMS PileCore web-API的公共Python SDK
此仓库由CEMS BV创建，是CEMS PileCore web-API的公共Python包装器。
安装
要在此仓库中安装包，请运行
$ pip install py-pilecore
环境变量
要使用py-pilecore，请将以下环境变量添加到您的环境中。或者当被要求时提供它们。
* NUCLEI_TOKEN
- Your NUCLEI user token
您可以在NUCLEI上获取您的NUCLEI_TOKEN。转到personal-access-tokens并创建一个新用户令牌。
贡献
环境
我们建议使用Python3.11在干净的虚拟环境中（使用virtualenv或conda）进行开发，并从requirements.txt文件中安装要求。
以下是在Linux上使用virtualenv和pip在新的环境.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/pypilecore tests notebooks
isort --settings-path "pyproject.toml" src/pypilecore tests notebooks
代码检查
为了保持代码质量，我们使用GitHub超级代码检查器。
要在本地运行代码检查器，请从根目录运行run_super_linters.sh bash脚本。
单元测试
使用覆盖率测试软件
python -m pip install --upgrade pip setuptools
pip install -r requirements.txt
pip install -e .
coverage run -m pytest
需求
需求由Python 3.11的pip-compile命令自动生成
使用以下命令安装pip-tools
pip install pip-tools
使用以下命令生成requirements.txt文件
pip-compile --extra=test --extra=lint --extra=docs --output-file=requirements.txt pyproject.toml
使用以下命令更新定义范围内的需求
pip-compile --upgrade --extra=test --extra=lint --extra=docs --output-file=requirements.txt pyproject.toml
下载文件
下载适合您平台的文件。如果您不确定选择哪个，请了解更多关于安装包的信息。
源代码分布
py_pilecore-0.7.1.tar.gz (56.0 kB 查看哈希值)
构建分布
py_pilecore-0.7.1-py3-none-any.whl (80.5 kB 查看哈希值)