与Encapsia系统通信的客户端API。
项目描述
Encapsia API库
用于与Encapsia一起工作的REST API。
安装
pip安装encapsia-api
贡献
encapsia-api是一个由poetry管理的python包。您需要Python 3.8或更高版本。要开始，在检出此存储库后，运行
poetry install
代码样式
此项目中的代码应使用black自动格式化，并遵循isort-like导入，同时应通过linting和检查。您可以手动运行以下命令，或将工具集成到您的开发环境中，但也可以参考下一节。
poetry run black .
poetry run ruff check .
poetry run mypy .
Ruff可以修复它发现的一些问题。例如，它可以修复模块导入的样式，但还可以做更多。可以通过运行
poetry run ruff check --fix .
但是，请确保检查它执行的所有修复！
版本控制
此项目的发布分支是master，功能分支应通过pull请求合并到其中。
该仓库使用 pre-commit 来运行各种检查，通过 git 预提交钩子。要开始使用，请运行
pre-commit install
之后，配置的检查会在您提交更改之前运行。您也可以显式地运行它们以检查所有文件
pre-commit run -a
版本控制
encapsia-api 遵循 语义版本控制。
要更改版本，请运行
poetry version <specifier> # e.g. patch
或在 pyproject.toml 中编辑版本字符串。在任何情况下，都要更新以下文件以匹配新版本：encapsia_api/__init__.py。
请注意，我们目前还处于 <1.0.0 的阶段，因此版本变更不是非常严格，并且在 1.0.0 之前可能仍然会发生向后不兼容的更改。
构建
通过运行以下命令手动构建：
poetry build
更新依赖关系
这是通过以下方式实现的：
poetry update
poetry lock
poetry export -f requirements.txt > requirements.txt
如何运行测试
运行
poetry run pytest
持续集成
本项目使用 Github Actions 在提交到或针对主分支的拉取请求中进行代码风格检查、检查和运行测试。
下载文件
下载适合您平台的应用程序。如果您不确定选择哪个，请了解更多关于 安装软件包 的信息。
源代码分发
encapsia_api-0.4.8.tar.gz (24.2 kB 查看哈希值)
构建分发
encapsia_api-0.4.8-py3-none-any.whl (26.7 kB 查看哈希值)
