geckoboard数据集api的官方python客户端
geckoboard.p的Python项目详细描述
用于Geckoboard datasets API的python客户端库。
注意:这个库仍然处于beta测试阶段,并且api有可能更改 在v1发布之前。
安装
使用pip安装软件包
pip install geckoboard.py
用法
最新的文档和用户指南可以在Geckoboard developer docs
开始
从pip安装python客户机
pip install geckoboard.py
导入geckoboard包并使用 您的API密钥:
importgeckoboardclient=geckoboard.client(API_KEY)
注意:您可以通过登录geckoboard找到您的api密钥 申请和访问帐户部分。
身份验证
验证您的api密钥是否有效,以及您是否可以访问geckoboard 使用ping方法的API。
client.ping()
示例:
client('good-api-key').ping()# => trueclient('bad-api-key').ping()# => raises Exception
查找或创建数据集
查找并验证现有数据集或创建具有 find_or_create方法。unique_by是一个或的可选列表 更多字段名,其值在所有记录中都是唯一的。
client.datasets.find_or_create(dataset_id,fields,unique_by)
参数:
示例:
dataset=client.datasets.find_or_create('sales.by_night',{'amount':{'type':'number','name':'Amount','optional':False},'timestamp':{'type':'datetime','name':'Time'}},['timestamp'])
下面是可用字段类型的完整列表 第页。
替换数据集中的所有数据
通过调用put方法替换数据集中的所有数据。
dataset.put(items)
参数:
- items[必需] <;list>;
示例:
dataset.put([{'timestamp':'2016-01-01T12:00:00Z','amount':819},{'timestamp':'2016-01-02T12:00:00Z','amount':409},{'timestamp':'2016-01-03T12:00:00Z','amount':164}])
向数据集追加数据
通过调用post方法将记录追加到数据集。
如果数据集中的记录数超过以下限制 一根柱子。
dataset.post(items,delete_by)
示例:
dataset.post([{'timestamp':'2016-01-03T12:00:00Z','amount':312},{'timestamp':'2016-01-04T12:00:00Z','amount':665},{'timestamp':'2016-01-05T12:00:00Z','amount':453}],'timestamp')
删除数据集
删除数据集和具有给定ID的所有数据。
client.datasets.delete(dataset_id)
参数:
- dataset_id[必需] <;str>;
示例:
client.datasets.delete('sales.gross')# => true
您还可以通过调用 数据集。
dataset=client.datasets.find_or_create(...)dataset.delete()# => true
开发
克隆此回购协议
git clone https://github.com/geckoboard/geckoboard-python && cd geckoboard-python
安装软件包依赖项
python setup.py develop
运行测试
nosetests