geckboard数据集api的包装器
geckoboard-python的Python项目详细描述
#壁虎数据集
[![生成状态](https://travis-ci.org/helium/geckoboard-python.svg?branch=master)](https://travis-ci.org/helium/geckoboard-python) [![覆盖状态](https://coveralls.io/repos/github/helium/geckoboard-python/badge.svg?branch=master)](https://coveralls.io/github/helium/geckoboard-python?分支=主) [![代码气候](https://codeclimate.com/github/helium/geckoboard-python/badges/gpa.svg)](https://codeclimate.com/github/helium/geckoboard-python)
geckoboard-python
是一个python包,用于创建和管理
[数据集](https://developer.geckoboard.com/api-reference/curl/)用于
壁虎(geckboard)服务更简单。
##安装
假设您正在使用pip
,请将这一行添加到您的setup.py
:
` requires = ['geckoboard-python] `
或者发送到您的requirements.txt
文件:
` geckoboard-python `
##用法和文档
##开发
为了开发这个代码库,您需要安装tox:
` pip install tox `
由于geckoboard-python
至少支持python 2.7和3.5,因此
需要在开发中至少安装其中一个
机器。当
代码被推送到这个存储库。
克隆此存储库并运行:
` $ tox `
这将安装所需的软件包并运行
图书馆。安装tox
无需安装或使用
virtualenv
因为tox已经管理虚拟环境。
默认情况下,测试将重放以前录制的api 互动。影响测试与api的交互方式 必须
- 将
GECKO_API_KEY
环境变量设置为有效的壁板api 钥匙。例如在bash
:
` $ export GECKO_API_KEY=<my api key> `
- 将
GECKO_RECORD_MODE
设置为以下值之一: - none-(默认)仅回放录制的API交互。
我们使用flake8
来确保捕捉到python版本的差异,并
常见的陷阱更快。请运行:
` $ tox -e lint `
在提交代码并尝试删除尽可能多的警告之前 可以。一旦我们弄清楚一些文档有多严格 我们将运行lint作为自动化的一部分。
使用有效的 [语义版本](https://semver.org)版本和推送标记。这个 构建自动化将自动构建并将发布推送到 [pypi](https://pypi.python.org)。