flask-bigtempo 0.8

Flask-BigTempo
--------------

Flask 扩展提供了几个用于创建 bigtempo 服务器的实用程序。

## 安装

`pip` 应该可以完成工作：
```bash
$ pip install flask-bigtempo
```

有一个 `requirements.txt` 文件是你想直接签出源代码。

-------------------------------------------------- -----------------------------

## Datastore API
用于存储时间序列数据。

每个时间序列都由一个“参考”和一个“符号”的连接来标识。
它的结构是这样的，因此可以将数据的源（或类型）声明为“引用”。
例子：
- 在股市背景下，“参考”可以是纳斯达克，而“符号”则留给公司股票。
- 存储国家“联合国人类发展指数”时，“参考”可以是“HDI”，而“符号”将采用国家名称或代码。

在这里您可以找到：

- 一个 __Storage__ 实现，它提供了保存/更新、检索和删除“pandas 数据帧”的方法
- 一个 __flask 扩展__，它公开了一个将数据处理为 json 的 REST API
- 一个可以与 REST API 通信的 __REST 客户端__
-一个 __command line script__ 可以使用 REST API 的 shell
- 一些 __bigtempo 数据源__ 允许轻松集成，毕竟，`store api` 的设计目的是为 `bigtempo` 提供数据。


### 存储实现
目前只有一种基于 SQLAlchemy 的实现。
你可以在 `flask_bigtempo/store/storages.py` 找到它。
使用示例见 `flask_bigtempo/store/clients.py`


### 烧瓶扩展：
您可以轻松地让烧瓶服务器公开 `bigtempo store api`:
```python
#!/usr/bin/env python


from flask import Flask
from flask.ext.sqlalchemy import SQLAlchemy
from flask.ext.bigtempo import DatastoreAPI


app = Flask(__name__)
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite://'

db = SQLAlchemy(app)

# 需要的datastore api flask 的应用实例和一个 sqlalchemy 引擎
datastore = DatastoreAPI(app, db.engine)


@app.route('/')
def hello_world():
return '''
<h1>欢迎！</h1>如果
__name__ ==
'


__main__':
app. run(debug=True)
```

以下方法可用：

- 数据检索：__GET__ /api/store/{reference}/{symbol}
- 数据插入：__PUT__ /api/store/{reference}/{symbol}
- 数据删除：__DELETE__ /api/store/{reference}/{symbol}

可选地，您可以使用附加的 url 参数：

- `json_format`（例如：`?json_format=index`）。
- `date_format`（例如：`?date_format=iso`）。



### REST 客户端
您可以在 `flask_bigtempo/store/clients.py` 找到它们：

- `DFStoreRestClient` 使用 Dataframes 作为输入和输出；
- `JSONStoreRestClient` 使用 JSON 作为输入和输出；

使用它应该很简单：
```python
import flask_bigtempo.store.clients as store_client

api = store_client.DFStoreRestClient()
dataframe = api.retrieve('HDI', 'Brazil')
```


### CL Script
Its代码可在 `scripts` 目录中找到。
一旦你在你的计算机上安装了这个库，`store_api` 应该在 PATH 中可用。您可以通过执行 `store_api -h` ### Bigtempo DataSources

了解有关其用法的更多信息



可在`flask_bigtempo/store/datasources.py` 获得。

您可以通过以下方式导入它：
```python
import flask_bigtempo.store.datasources as datasources

ds = datasources.RESTStoreDatasource('example')
```

剩下的就是将它注册到您的 bigtempo 引擎。