Regobs 的客户端库
项目描述
regobslib — Regobs 客户端库
该客户端库旨在简化与 Regobs API v5 的交互。
先决条件
- 测试或生产环境的客户端 ID，请联系regobs@nve.no获取此信息。
- 测试或生产环境的用户帐户。在这里注册：
- 关于雪科学命名法的基本知识。有关详细信息，请参阅以下资源：
安装
要安装使用pip：
pip install regobslib
示例程序
搜索数据
这是一个在 Ofoten 中搜索天气观测的示例程序。
from regobslib import *
connection = Connection(prod=True)
results = connection.search(SnowRegistration, regions=[SnowRegion.OFOTEN], observation_types=[Weather])
print(f"Length of results: {len(results)}\n")
print("First result")
print(results[0])
print("\nIterates over results")
for result in results:
print(f"Id: {result.id}, Observer: {result.observer.nickname}, Date: {result.obs_time}")
提交数据
下面是一个简单的程序，演示了如何在给定的位置和时间注册一个 whumpf 声音。
from regobslib import *
import datetime as dt
# Contact regobs@nve.no to get a client ID.
CLIENT_ID = "00000000-0000-0000-0000-000000000000"
# Create a user at https://test-konto.nve.no/ or https://konto.nve.no/
USERNAME = "ola.nordmann@example.com"
PASSWORD = "P4ssw0rd"
# First we create an empty SnowRegistration object
reg = SnowRegistration(REGOBS_TZ.localize(dt.datetime(2021, 8, 17, 9, 48)),
Position(lat=68.4293, lon=18.2572))
# Then we add a DangerSign observation to it
reg.add_danger_sign(DangerSign(DangerSign.Sign.WHUMPF_SOUND))
# Authenticate to Regobs to be able to submit observations
connection = Connection(prod=False).authenticate(USERNAME, PASSWORD, CLIENT_ID)
# Send our SnowRegistration to Regobs
stored_reg = connection.submit(reg)
print(stored_reg)
有关更广泛的演示，请参阅demo.py。
文档
我们还没有编写文档，但是函数声明是用类型提示编写的，并且大多数参数都是枚举，因此 submit.py 中的代码 可能会帮助您。正确设置的 IDE 还将使用类型提示和枚举来通知您有关您的替代方案。
您还可以使用 GitHub 内置的代码导航快速找到示例代码中的类或方法的定义。
下载文件
下载适用于您平台的文件。如果您不确定要选择哪个，请了解有关安装包的更多信息。
源分布
regobslib-0.2.13.tar.gz
（34.0 kB
查看哈希）
内置分布
regobslib-0.2.13-py3-none-any.whl
（34.7 kB
查看哈希）