EBI本体查找服务的客户端
项目描述
OLS客户端
EBI本体查找服务(OLS)和其他实例的客户端。
💪 入门
可以通过相同的API实例化并访问OLS客户端之一。
from ols_client import EBIClient
ebi_client = EBIClient()
ontologies = ebi_client.get_ontologies()
更多文档可以在ols-client.readthedocs.io找到。
🚀 安装
可以从PyPI安装最新版本
$ pip install ols_client
可以直接从GitHub使用以下命令安装最新代码和数据
$ pip install git+https://github.com/cthoyt/ols-client.git
👐 贡献
贡献,无论是在提交问题、提交拉取请求还是进行分支操作,都是受欢迎的。有关参与的更多信息,请参阅CONTRIBUTING.md。
👋 归档
⚖️ 许可证
本包中的代码根据MIT许可证授权。
相关
自创建此存储库以来,EBI还创建了自己的客户端,可在https://github.com/Ensembl/ols-client和PyPI上作为ebi-ols-client
找到。
🍪 Cookiecutter
此软件包是使用@audreyfeldroy的cookiecutter软件包以及@cthoyt的cookiecutter-snekpack模板创建的。
🛠️ 对于开发者
查看开发者说明
README文件的最后一部分是关于如果你想通过代码贡献来参与其中。
开发安装
要在开发模式下安装,请使用以下命令
$ git clone git+https://github.com/cthoyt/ols-client.git
$ cd ols-client
$ pip install -e .
🥼 测试
在克隆存储库并使用pip install tox
安装tox后,可以使用以下命令反复运行tests/
文件夹中的单元测试
$ tox
此外,这些测试会在GitHub Action的每次提交时自动重新运行。
📖 构建文档
可以使用以下命令在本地构建文档
$ git clone git+https://github.com/cthoyt/ols-client.git
$ cd ols-client
$ tox -e docs
$ open docs/build/html/index.html
文档会自动安装软件包以及setup.cfg
中指定的docs
额外软件包。可以在这里添加texext
等docs/source/conf.py
中的extensions
列表中。
📦 创建发布版本
在开发模式下安装软件包并使用pip install tox
安装tox后,创建新版本的命令包含在tox.ini
中的finish
环境中。请在shell中运行以下命令
$ tox -e finish
此脚本执行以下操作
- 使用Bump2Version将
setup.cfg
、src/ols_client/version.py
和docs/source/conf.py
中的版本号切换为不带-dev
后缀 - 使用
build
在tar存档和wheel中打包代码 - 使用
twine
上传到PyPI。请确保已配置.pypirc
文件,以避免在此步骤中需要手动输入 - 推送到GitHub。您需要创建一个与版本号提升的提交对应的发布版本。
- 将版本提升到下一个补丁版本。如果您进行了重大更改并希望通过次要版本提升版本,可以在之后使用
tox -e bumpversion minor
项目详情
下载文件
下载适合您平台的项目文件。如果您不确定选择哪个,请了解更多关于安装软件包的信息。
源分布
构建分布
ols_client-0.1.4.tar.gz的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | cd2a0f39107f39eaf0f40b9098f12d442cf3d43e28228e63feb407d0aeb44470 |
|
MD5 | 0bf1034930a8b117ec2cdad680df861a |
|
BLAKE2b-256 | 7a09eeca61cc40048d764dacb955e5991cb13f16efe841e6eed37ad7e2a601ec |
ols_client-0.1.4-py3-none-any.whl的哈希
算法 | 哈希摘要 | |
---|---|---|
SHA256 | 7bdca0590042e07cc7ee3ef3fba99c3b6862cde6c8835afb129de31284b3e010 |
|
MD5 | ad6546ab50b3b4068553aee21a93e06f |
|
BLAKE2b-256 | 1490104f364c37ff9e5f250540da38a00ba5e7facd05a831bd089f8ed7b7cc2e |