跳转到主要内容

GBIF的Python客户端

项目描述

pygbif

pypi docs ghactions coverage black

GBIF API的Python客户端

在GitHub上的源代码:gbif/pygbif

其他GBIF客户端

贡献: CONTRIBUTING.md

安装

从pypi稳定版本

pip install pygbif

开发版本

[sudo] pip install git+git://github.com/gbif/pygbif.git#egg=pygbif

pygbif被分为针对API方法的主要组的模块。

  • 注册 - 数据集、节点、安装、网络、组织

  • 物种 - 分类学名称

  • 出现次数 - 出现数据,包括下载API

  • 地图 - 获取来自GBIF的栅格地图,格式为png或mvt

您可以选择导入整个库,或根据需要单独导入每个模块。

此外,还有一个utils模块,目前包含一个方法:wkt_rewind,以及一个用于管理是否缓存HTTP请求的caching方法。请参阅?pygbif.caching

注册模块

注册模块API

  • 组织机构

  • 节点

  • 网络

  • 安装

  • 数据集

  • 数据集度量

  • 数据集建议

  • 数据集搜索

示例用法

from pygbif import registry
registry.dataset_metrics(uuid='3f8a1297-3259-4700-91fc-acc4170b27ce')

物种模块

物种模块API

  • name_backbone

  • name_suggest

  • name_usage

  • name_lookup

  • name_parser

示例用法

from pygbif import species
species.name_suggest(q='Puma concolor')

出现次数模块

注册模块API

  • 搜索

  • 获取

  • 获取原始数据

  • 获取片段

  • 计数

  • 基于记录的计数

  • 按年份计数

  • 按数据集计数

  • 按国家计数

  • 按模式计数

  • 按出版国家计数

  • 下载

  • 下载元数据

  • 下载列表

  • 下载获取

示例用法

from pygbif import occurrences as occ
occ.search(taxonKey = 3329049)
occ.get(key = 252408386)
occ.count(isGeoreferenced = True)
occ.download('basisOfRecord = PRESERVED_SPECIMEN')
occ.download('taxonKey = 3119195')
occ.download('decimalLatitude > 50')
occ.download_list(user = "sckott", limit = 5)
occ.download_meta(key = "0000099-140929101555934")
occ.download_get("0000066-140928181241064")

地图模块

地图模块API

  • 地图

示例用法

from pygbif import maps
out = maps.map(taxonKey = 212, year = 1998, bin = "hex",
       hexPerTile = 30, style = "classic-noborder.poly")
out.response
out.path
out.img
out.plot()
https://github.com/gbif/pygbif/raw/master/gbif_map.png

utils模块

utils模块API

  • wkt_rewind

示例用法

from pygbif import utils
x = 'POLYGON((144.6 13.2, 144.6 13.6, 144.9 13.6, 144.9 13.2, 144.6 13.2))'
utils.wkt_rewind(x)

贡献者

元数据

变更日志

0.6.4 (2024-03-12)

  • 修复了使用readthedocs构建文档时的一个错误(编号138,编号129)

  • 测试现在针对实时GBIF API运行(编号101,编号128)

  • 更新了caching.py,因为remove_expired_responses方法已弃用(编号126)

0.6.3 (2023-05-25)

  • 增加了对谓词的支持:isNull,isNotNull,in和not(编号92,编号102和编号103)

  • 增加了对嵌套查询/字典的支持(编号104)

  • 弃用了add_predicate函数,并添加了add_pred_dict以适应新支持的谓词,以确保在payload函数中添加的参数是正确的(编号108)

  • 增加了对多种下载格式的支持(编号105)

  • 更新了操作符和查找表(编号107)

  • 包括对新支持的谓词和字典的文档(编号106)

0.6.2 (2023-01-24)

  • 更新以修复请求GBIF下载的问题

  • 较小的文档更新(编号95和编号99)

0.6.1 (2022-06-23)

  • 更新以修复损坏的依赖关系(编号93)

  • 较小的文档更新

0.6.0 (2021-07-08)

  • 修复了在以字符串形式提供几何形状而不是使用add_geometry时,对occurrences.download的修复;谓词在空白处被分割,这在WKT中不起作用(编号81,编号84)

  • 将使用logging模块而不是print()来提供有关出现下载方法的信息(编号78)

  • 明确指出,occurrences.count对于长度为1的输入;有关> 1个值的输入,请参阅occurrences.search(编号75,编号77)

  • 改进了species.name_usage方法的文档,主要针对language参数(编号68)

  • Gains下载方法download_cancel用于取消/删除下载请求(编号59)

0.5.0 (2020-09-29)

  • occurrences.search现在支持recordedByID和identifiedByID搜索参数(编号62)

  • 清理了贡献者文件,感谢@niconoe(编号64)

  • 清理了库中的内部导入,感谢@niconoe(编号65)

  • 修复了is和==的使用,有时使用不当(通过https://realpython.com/python-is-identity-vs-equality/),(编号69)

  • 删除了文档字符串中的冗余参数,感谢@faroit(编号71)

  • 使内部函数gbif_GET_write的测试更通用,以避免GBIF略微更改内容类型响应标头时出错(编号72)

0.4.0 (2019-11-20)

  • 将所有请求的基本URL更改为https;在之前的版本中,地图和下载已经是https

  • 出现、物种和注册模块为每个方法添加了文档字符串,简要总结了每个方法

  • pygbif现在具有缓存HTTP请求的功能。默认情况下,缓存是关闭的。有关所有详细信息,请参阅 ?pygbif.caching52 56),通过 @nleguillarme 实现

  • 在文档中注明,如果您试图获得与GBIF网站相同的名称搜索行为,则 species.name_backbone 可能是您想要的 55 感谢 @qgroom

  • 对于期望布尔值的参数,在执行HTTP请求之前,将其转换为小写字符串

0.3.0 (2019-01-25)

  • pygbif现在只支持Python 3 19

  • 添加了地图模块,其中包含用于处理GBIF地图API的 maps.map 方法 41 49

  • 添加了新的模块 utils,其中包含一个方法 wkt_rewind 46 感谢 @aubreymoore 的灵感

  • 修复了 registry.installations 中的错误:一个参数的拼写错误,将 identifierTyp 误写为 identifierType 48 感谢 @data-biodiversity-aq

  • 从Changelog链接到GitHub问题 🎉

  • 修复了出现下载测试 47

  • 文档更加详尽 25

0.2.0 (2016-10-18)

  • 下载方法得到很大改进 16 27 感谢 @jlegind @stijnvanhoey @peterdesmet !

  • geometry 参数中现在支持 MULTIPOLYGON 35

  • 修复了 occurrences.getoccurrences.get_verbatimoccurrences.get_fragment 和使用已不再存在于GBIF中的出现密钥的演示的文档 39

  • registry 模块添加了 organizations 方法 12

  • 添加了数据集方法的其余部分:包括分面支持的 registry.dataset_searchregistry.dataset_suggest,分别对应于 /dataset/search/dataset/suggest 路径 40

  • 添加了物种方法的其余部分:包括分面支持的 species.name_lookupspecies.name_usage,分别对应于 /species/search/species 路径 18

  • 添加更多测试以覆盖新方法

  • species.name_suggest 更改为返回来自GBIF的数据结构。我们曾经解析分类数据,但现在为了简单和速度,将其留给用户。

  • species.name_suggestoccurrences.download_listregistry.organizationsregistry.nodesregistry.networksregistry.installations 中的 start 参数已更改为 offset,以匹配GBIF API并匹配 pygbif 其余部分的用法

0.1.5.4 (2016-10-01)

  • 添加了更多 occurrence.search 参数,包括 repatriatedkingdomKeyphylumKeyclassKeyorderKeyfamilyKeygenusKeysubgenusKeyestablishmentMeansfacetfacetMincountfacetMultiselect,以及通过 **kwargs 支持分面分页 30 34

  • 修复了 occurrence.search 中的 **kwargs,以便正确解析分面参数并正确收集 requests GET请求选项 36

  • occurrence.search 添加了 spellCheck 参数,与 q 参数一起使用,可选地对全文搜索进行拼写检查 31

0.1.4 (2016-06-04)

  • 在文档中添加了变量类型

  • occurrences.search 方法的默认 limit 值更改为300

  • tox 现在包含在内,通过 @xrotwang 20

  • 添加了更多注册方法 11

  • 开始实现出现下载方法 16

  • 添加了更多名称方法 18

  • 现在所有请求都通过 requestspygbif 版本发送用户代理头 13

  • 修复了 occurrences.download_get 的错误 23

  • 修复了 occurrences.get 中的错误示例 22

  • 修复了通用轮子以支持2和3 10

  • 大幅改进了文档,自动文档方法现在

0.1.1 (2015-11-03)

  • 修复了pypi的发行版

0.1.0 (2015-11-02)

  • 首次发布

项目详情


下载文件

下载您平台上的文件。如果您不确定选择哪个,请了解有关安装包的更多信息。

源分发

pygbif-0.6.4.tar.gz (55.5 kB 查看哈希值)

上传时间

构建分发

pygbif-0.6.4-py3-none-any.whl (64.3 kB 查看哈希值)

上传时间 Python 3

由以下提供支持

AWSAWS云计算和安全赞助商DatadogDatadog监控FastlyFastlyCDNGoogleGoogle下载分析MicrosoftMicrosoftPSF赞助商PingdomPingdom监控SentrySentry错误日志StatusPageStatusPage状态页