用于BioPortal和其他OntoPortal实例的客户。
项目描述
OntoPortal客户端
用于BioPortal和其他OntoPortal实例的客户。
💪 入门
可以使用相同的API实例化和访问多个OntoPortal客户端之一
from ontoportal_client import BioPortalClient
bioportal_client = BioPortalClient()
ontologies = bioportal_client.get_ontologies()
完整文档可在ontoportal-client.readthedocs.io找到
🚀 安装
$ pip install ontoportal_client
可以直接使用GitHub安装最新的代码和数据
$ pip install git+https://github.com/cthoyt/ontoportal-client.git
⚙️ 配置
每个客户端的API令牌配置由pystow介导。以BioPortal为例，您可以
- 在客户端类的构造函数中传递API密钥
- 设置环境变量
BIOPORTAL_API_KEY - 创建文件
~/.config/bioportal.ini并在[bioportal]部分下设置api_key值。
👐 贡献
贡献，无论是提交问题、提交拉取请求还是分叉，都受到赞赏。有关如何参与的更多信息，请参阅CONTRIBUTING.md。
👋 致谢
⚖️ 许可证
此包中的代码根据MIT许可证授权。
🍪 Cookiecutter
此软件包使用@audreyfeldroy的cookiecutter软件包和@cthoyt的cookiecutter-snekpack模板创建。
🛠️ 开发者指南
查看开发者说明
README的最后一部分是为那些希望通过代码贡献参与其中的人准备的。
开发安装
要在开发模式下安装，请使用以下命令
$ git clone git+https://github.com/cthoyt/ontoportal-client.git
$ cd ontoportal-client
$ pip install -e .
🥼 测试
在克隆存储库并使用pip install tox安装tox之后，可以使用以下命令重复运行tests/文件夹中的单元测试
$ tox
此外，这些测试在每次提交到GitHub Action时都会自动重新运行。
📖 构建文档
可以使用以下命令在本地构建文档
$ git clone git+https://github.com/cthoyt/ontoportal-client.git
$ cd ontoportal-client
$ tox -e docs
$ open docs/build/html/index.html
文档自动安装包以及setup.cfg中指定的docs额外组件。sphinx插件如texext可以添加到那里。另外，它们还需要添加到docs/source/conf.py中的extensions列表。
📦 发布版本
在开发模式下安装包并使用pip install tox安装tox之后，创建新版本的命令包含在tox.ini中的finish环境中。请在shell中运行以下命令
$ tox -e finish
此脚本执行以下操作
- 使用Bump2Version将
setup.cfg、src/ontoportal_client/version.py和docs/source/conf.py中的版本号更改为不带-dev后缀 - 使用
build将代码打包成tar存档和wheel - 使用
twine上传到PyPI。请确保配置了.pypirc文件以避免在此步骤中手动输入 - 推送到GitHub。您需要在版本号提升的提交中创建一个发布版本。
- 将版本提升到下一个补丁级别。如果您进行了重大更改并希望通过次要版本提升版本，可以在之后使用
tox -e bumpversion minor
ontoportal_client-0.0.4.tar.gz 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 1bf7edcb94db3ed68ea9a64c620056f0517f7e209826b05dbfda8fe27384fa48 |
|
| MD5 | d47703b807e127fb0928b15e8f6c295a |
|
| BLAKE2b-256 | 8c6275d09f625e9a2c595a8bc102c030b1fe1f7b0289d66ffd1a0e3c71300b7a |
ontoportal_client-0.0.4-py3-none-any.whl的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 0dedd4ce003e0b6c1128fa05101e57bcc128ad79a6c9fcae66037d2447706c4c |
|
| MD5 | df20ed92661abcb42a76de5f51bc5242 |
|
| BLAKE2b-256 | f105e5c614587b7770445c4794f0965b5a0d83829bd9a2f80eb8e285d6377f2b |