pyzeef 0.1.3

pyzeef
======

[](https://landscape.io/github/ellisonleao/pyzeef/master)
[](https://travis-ci.org/ellisonleao/pyzeef)

欢迎使用Python Zeef API库。

## 目录

- [安装](#installing)
- [基本用法](#basic-usage)
- [Zeef类](#the-zeef-class)
- [页面类](#the-page-class)
- [区块类](#the-block-class)
- [链接类](#the-link-class)


## 安装

使用pip

```
pip install pyzeef
```

或克隆并安装当前构建
```
git clone https://github.com/ellisonleao/pyzeef.git
cd pyzeef
python setup.py develop
```
强烈建议在安装上述任何方法之前使用virtualenv。

## [基本用法](#basic-usage)

在开始之前，您需要一个ZEEF令牌才能使用此库。
要生成新的令牌，请[点击这里](https://zeef.com/dashboard/user/profile/tokens)

生成您的令牌后

from pyzeef import Zeef

```python
z = Zeef('YOUR-TOKEN')
print z.pages
# 输出
[
<Page ID>,
...
]
```

### [Zeef类](#zeef-class)

## `Zeef(token, persist_pages=True, get_scratchpad=True)`

在实例化新的Zeef类时，默认情况下也会持久化您的所有页面和刮板。如果您不想获取页面和/或刮板，可以在创建新类时传递`persist_pages`和`get_scratchpad`参数。

#### 方法

#### `authorize(token=None, persist_pages=True)`

该方法将在对象创建时被调用，如果 `persist_pages=True`。它将授权并持久化您的令牌以通过所有API请求，并获取/持久化您的ZEEF页面。您还可以在实例化类时传递新的
令牌。该令牌将被持久化以用于未来的请求。

#### `get_page(page_id=int, alias=string, username=string)`

您可以通过传递`page_id`或同时传递`alias`和`username`来获取页面
这将返回一个[Page](#page)类。


### `get_block(block_id)`

如果找到具有提供的`block_id`的任何块，则这将返回一个[Block](#block)类对象。

### `get_link(link_id)`

如果找到具有提供的`link_id`的任何链接，则这将返回一个[Link](#link)类对象。

### `create_page(name, language='en', type=['SUBJECT', 'COMPANY', 'PERSONAL'])`

创建新页面的快捷方法，给定名称、语言和类型。这将返回一个包含新页面信息的Page实例。

### 主要属性

- `page` - 这将返回获取到的页面列表，作为[Page](#page)对象。

### [页面类](#page)

在获取页面时，有一个辅助类可以帮助您执行Zeef页面CRUD操作。

#### 方法

#### `update(type=['SUBJECT', 'COMPANY'], description='your description')`

更新当前页面。两个字段都是可选的。

### `to_markdown()`

这将以markdown格式输出您的ZEEF页面。

### 主要属性

- `blocks` - 页面可以包含多个块。在检索页面时，blocks属性将返回一个[Block](#block)对象列表，以帮助进行块API操作。
- `title` - 页面标题。

### [块类](#block-class)

### 方法

### `update(data)`

使用给定的数据字典更新当前块。`data`键可以是

- `title` - 字符串
- `promoted` - 布尔值
- `publicly_visible` - 布尔值

对于`link`类型的块，我们可以添加

- `description` - 字符串

对于`feed`类型的`blocks`，我们可以添加

- `feed_url` - URL字符串
- `max_links` - 整数
- `refresh_minutes` - 整数


### `delete()`

从页面中删除块

### 主要属性

- `links` - [Link](#link)对象的列表，以帮助进行链接API操作
- `title` - 块标题
- `type` - 块类型

### [链接类](#link-class)

### 方法

### `update(link='http://mylink.com', description='text', title='title')`

使用提供的kwargs更新当前链接。

### `delete()`

删除链接

### 主要属性

- `title` - 链接标题
- `url` - 链接URL