跳转到主要内容

EBI本体查找服务的客户端

项目描述

OLS客户端

Tests PyPI PyPI - Python Version PyPI - License Documentation Status Codecov status Cookiecutter template from @cthoyt Code style: black Contributor Covenant DOI

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

此软件包是使用@audreyfeldroycookiecutter软件包以及@cthoytcookiecutter-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

此脚本执行以下操作

  1. 使用Bump2Versionsetup.cfgsrc/ols_client/version.pydocs/source/conf.py中的版本号切换为不带-dev后缀
  2. 使用build在tar存档和wheel中打包代码
  3. 使用twine上传到PyPI。请确保已配置.pypirc文件,以避免在此步骤中需要手动输入
  4. 推送到GitHub。您需要创建一个与版本号提升的提交对应的发布版本。
  5. 将版本提升到下一个补丁版本。如果您进行了重大更改并希望通过次要版本提升版本,可以在之后使用tox -e bumpversion minor

项目详情


下载文件

下载适合您平台的项目文件。如果您不确定选择哪个,请了解更多关于安装软件包的信息。

源分布

ols_client-0.1.4.tar.gz (16.3 kB 查看哈希值)

上传时间

构建分布

ols_client-0.1.4-py3-none-any.whl (10.2 kB 查看哈希值)

上传时间 Python 3

由以下支持