Readability API Python 客户端技术文档

本文档将详细介绍如何安装和使用 readability-api，这是 Readability 官方的 Python 客户端，它提供了对 Readability 解析器 API 和阅读器 API 的访问。

1. 安装指南

安装 readability-api 的最新版本非常简单，您可以使用 pip 进行安装：

pip install readability-api

2. 项目的使用说明

readability-api 提供了对 Readability 的解析器 API 和阅读器 API 的访问。以下是基本的使用说明：

• 解析器 API：用于解析网页内容，提取文章标题、内容和主要结构。
• 阅读器 API：用于访问和管理用户的 Readability 阅读列表。

解析器 API 使用示例

from readability import ParserClient

parser_client = ParserClient('your_parser_token')
parser_response = parser_client.get_article('http://example.com/article')
article = parser_response.json()

print(article['title'])  # 输出文章标题
print(article['content'])  # 输出文章内容

阅读器 API 使用示例

from readability import ReaderClient

# 如果没有在构造函数中传递客户端凭据，它们将在环境变量中查找
client = ReaderClient(token_key='a user\'s key', token_secret='a user\'s secret')
bookmarks_response = client.get_bookmarks(favorite=True)

print(bookmarks_response.json())  # 输出用户的收藏夹书签

3. 项目API使用文档

以下是 readability-api 的一些主要 API 方法：

解析器客户端 (ParserClient)

• get_article(url): 解析给定 URL 的网页内容。

阅读器客户端 (ReaderClient)

• get_bookmarks(favorite=False): 获取用户的书签列表，可以选择是否只获取收藏夹中的书签。
• add_bookmark(url): 将新的 URL 添加到用户的阅读列表。
• delete_bookmark(url): 从用户的阅读列表中删除 URL。

4. 项目安装方式

除了使用 pip 安装外，您还可以从源代码安装 readability-api。以下是步骤：

1. 克隆 GitHub 仓库：

git clone https://github.com/arc90/python-readability-api.git
cd python-readability-api

2. 安装依赖项并运行测试：

pip install -r requirements.txt
tox

3. 将源代码添加到您的项目中，并按照前面的使用说明进行操作。

注意：在进行任何集成测试之前，请确保您已经在 Readability 上创建了单独的测试用户账户，以避免干扰您的阅读列表。

以上是 readability-api 的技术文档，希望对您的使用有所帮助。