Open-Spending的命令行工具。
项目描述
[](https://travis-ci.org/openspending/gobble)
# Gobble
Gobble是[Open-Spending](next.openspending.org)的客户端API，这是一个国际平台，用于打包、共享和可视化预算数据。Gobble与[打包器界面](next.openspending.org/packager)的功能完全相同，只是程序化。它既可以作为Python客户端，也可以作为命令行界面使用。它与3.3、3.4、3.5版本兼容。2.7版本的支持正在开发中。您可以通过`pip`安装它。
```
pip安装os-gobble
```
## 财务数据包
一个通用的[数据包](http://frictionlessdata.io/data-packages/)是一种轻量级的数据容器。一个[财政数据包](http://fiscal.dataprotocols.org/)是专门用于政府预算和支出数据的一种特殊数据包。它是面向用户的，旨在对发布数据（例如政府）和使用数据（如研究人员和记者）的人都非常易于使用。
从技术角度来看，一个财政数据包由一个指向数据文件的`JSON`描述符组成。`JSON`描述符需要遵循[财政数据规范](http://fiscal.dataprotocols.org/spec/)。一个基本的本地财政数据包可能看起来像这样
```
/basepath/budget.json
/data/budget_2014.csv
budget_2015.csv
```
一旦您的财政数据包准备就绪，您就可以开始使用Gobble了。
## 命令行界面
Asciinema即将到来...
## Python客户端
### 财政数据包对象
在Gobble中，财政数据通过`FiscalDataPackage`类来表示。它是定义在[datapackage-py](https://github.com/frictionlessdata/datapackage-py)库中的`DataPackage`类的子类。要创建`FiscalDataPackage`对象，将描述符的路径传递给构造函数
```
user = User()
budget = FiscalDataPackage('path/to/my/package/descriptor.json', user=user)
```
请注意，截至目前，Open-Spending只支持`CSV`格式的数据文件，所以如果您尝试传递其他格式，`FiscalDataPackage`将引发`NotImplementedError`错误。
### 验证
要验证财政数据包模式和数据
```
bugdet.validate()
```
如果数据包无效，将引发`ValidationError`。要获取错误列表（更有帮助），将`raise_on_error`标志设置为`False`。
```
budget.validate(raise_error=False)
```
### 上传
要将财政数据包上传到Open-Spending
```
url = budget.upload() # 包在Open-Spending查看器中的URL
```
默认情况下，上传的包会立即发布。您可以像这样切换发布状态
```
new_state = budget.toggle('private') # 返回'private'
```
### 搜索
您可以通过以下方式从Open-Spending平台搜索现有的财政数据包
```
results = search('mexico')
results = search('MX', {'author': 'mickey_mouse'})
```
其中`results`是一个数据包列表（字典）。可用的搜索键有：`size`，`title`，`author`，`description`，`region`，`country`，`city`。
## 资源
- [Open-Spending网络平台](next.openspending.org)
- [Open-Spending开发者文档](http://docs.openspending.org/en/latest/)
- [datapackage-py包仓库](http://frictionlessdata.io/data-packages/)
- [财政数据包主页](http://fiscal.dataprotocols.org/)
- [开放知识基金会](https://okfn.org)
## 许可证
Gobble遵循[MIT许可证](https://open-source.org.cn/licenses/MIT)。
## 贡献
我们欢迎反馈、问题和拉取请求。请查看[贡献指南](https://github.com/okfn/coding-standards)。
# Gobble
Gobble是[Open-Spending](next.openspending.org)的客户端API，这是一个国际平台，用于打包、共享和可视化预算数据。Gobble与[打包器界面](next.openspending.org/packager)的功能完全相同，只是程序化。它既可以作为Python客户端，也可以作为命令行界面使用。它与3.3、3.4、3.5版本兼容。2.7版本的支持正在开发中。您可以通过`pip`安装它。
```
pip安装os-gobble
```
## 财务数据包
一个通用的[数据包](http://frictionlessdata.io/data-packages/)是一种轻量级的数据容器。一个[财政数据包](http://fiscal.dataprotocols.org/)是专门用于政府预算和支出数据的一种特殊数据包。它是面向用户的，旨在对发布数据（例如政府）和使用数据（如研究人员和记者）的人都非常易于使用。
从技术角度来看，一个财政数据包由一个指向数据文件的`JSON`描述符组成。`JSON`描述符需要遵循[财政数据规范](http://fiscal.dataprotocols.org/spec/)。一个基本的本地财政数据包可能看起来像这样
```
/basepath/budget.json
/data/budget_2014.csv
budget_2015.csv
```
一旦您的财政数据包准备就绪，您就可以开始使用Gobble了。
## 命令行界面
Asciinema即将到来...
## Python客户端
### 财政数据包对象
在Gobble中，财政数据通过`FiscalDataPackage`类来表示。它是定义在[datapackage-py](https://github.com/frictionlessdata/datapackage-py)库中的`DataPackage`类的子类。要创建`FiscalDataPackage`对象，将描述符的路径传递给构造函数
```
user = User()
budget = FiscalDataPackage('path/to/my/package/descriptor.json', user=user)
```
请注意，截至目前，Open-Spending只支持`CSV`格式的数据文件，所以如果您尝试传递其他格式，`FiscalDataPackage`将引发`NotImplementedError`错误。
### 验证
要验证财政数据包模式和数据
```
bugdet.validate()
```
如果数据包无效，将引发`ValidationError`。要获取错误列表（更有帮助），将`raise_on_error`标志设置为`False`。
```
budget.validate(raise_error=False)
```
### 上传
要将财政数据包上传到Open-Spending
```
url = budget.upload() # 包在Open-Spending查看器中的URL
```
默认情况下，上传的包会立即发布。您可以像这样切换发布状态
```
new_state = budget.toggle('private') # 返回'private'
```
### 搜索
您可以通过以下方式从Open-Spending平台搜索现有的财政数据包
```
results = search('mexico')
results = search('MX', {'author': 'mickey_mouse'})
```
其中`results`是一个数据包列表（字典）。可用的搜索键有：`size`，`title`，`author`，`description`，`region`，`country`，`city`。
## 资源
- [Open-Spending网络平台](next.openspending.org)
- [Open-Spending开发者文档](http://docs.openspending.org/en/latest/)
- [datapackage-py包仓库](http://frictionlessdata.io/data-packages/)
- [财政数据包主页](http://fiscal.dataprotocols.org/)
- [开放知识基金会](https://okfn.org)
## 许可证
Gobble遵循[MIT许可证](https://open-source.org.cn/licenses/MIT)。
## 贡献
我们欢迎反馈、问题和拉取请求。请查看[贡献指南](https://github.com/okfn/coding-standards)。
