shamrock 0.0.1

安装

pipenv install shamrock

或

pip install shamrock

简单用法示例

from shamrock import Shamrock
api = Shamrock('mytoken')
species = api.species()

高级使用

您可以按如下方式对api进行初始配置：

api = Shamrock(TOKEN, page_size=10)

目前，页面大小是唯一可用的选项。

可以使用api运行的方法是：

api.kingdoms()
api.subkingdoms()
api.divisions()
api.families()
api.genuses()
api.plants()
api.species()

它们对应于trefle api端点。

您还可以从数据库中查询特定项目：

api.plants(103505)

搜索包含在单独的方法中：

api.search("tomato")

导航api包含以下方法：

api.next()
api.prev()
api.first()
api.last()

只有在你之前提出要求的情况下它才会起作用。例如：

api.species()
api.next()

默认情况下，api使用trefle中设置的任何数字的列表进行响应。你可以 使用前面提到的页面大小操作它：

api.species(page_size=5)

您还可以使用trefle api文档中描述的varoius查询字符串选项作为关键字 方法中的参数：

api.species(common_name="blackwood")