Skip to main content

尝试解析出知乎官方未开放的 OAuth2 接口,并提供优雅的使用方式,作为 zhihu-py3 项目的替代者

Project description

# Zhihu-OAuth

[![author][badge-author]][my-zhihu] [![docs][badge-docs]][rtds-home] [![version][badge-version]][pypi] [![py-version][badge-py-version]][pypi] [![state][badge-state]][pypi] [![license][badge-license]][license]

## 简介

最近在尝试解析出知乎官方未开放的 OAuth2 接口,顺便提供优雅的使用方式,作为 [zhihu-py3][zhihu-py3-github] 项目的继任者。

恩,理论上来说会比 zhihu-py3 更加稳定,原因如下:

- 知乎 API 相比前端 HTML 来说肯定更加稳定和规范
- 这次的代码更加规范
- 网络请求统一放在基类中
- 属性解析统一放在装饰器中,各知乎类只用于声明有哪些属性可供使用
- 统一翻页逻辑,再也不用一个地方一个逻辑了
- 翻页时的自动重试机制(虽然不知道有没有用吧)

这一新库与 zhihu-py3 相比速度更快。有关速度对比的详细信息请点击[这里][speed-compare]。

**这个库是 Py2 和 Py3 通用的!** 但是 Py3 的优先级比 Py2 高,也就是说,我会优先保证在 Py3 下的稳定性和正确性。毕竟在我学的时候选了 Py3,所以对 2 与 3 的差异了解不是很清楚,Py2 只能尽力而为了,

目前版本是 0.0.5,没更新的快更新一下,更新说明在[这里][changelog]。

后期的计划是这样的:

- 0.0.1 - 0.0.9 这个阶段是 alpha 期,主要做的是补齐功能的工作。基本上 TODO 里的功能都会在这个时期实现。其中 0.0.5 版本计划完成和 zhihu-py3 同样多的功能(**已完成**)。
- 0.1.0 - 0.1.9 这个阶段是 beta 期,主要做完善测试,修复 bug,提升性能,改善架构之类的工作吧。以上两个阶段变化很大,有可能出现不兼容老版本的更新。使用需要注意……
- 0.2.0 以后就是 stable 期,只要 API 不变,基本上代码结构就不会变了,可能也会修 bug,但是接口都不会变了,可能会加,但是不会减也不会变。

由于现在使用的 CLIENT_ID 和 SECRET 的获取方法并不正当,所以请大家暂时不要大规模宣传,自己用用就好啦,Thanks。

等我什么时候觉得时机成熟(等知乎真•开放 OAuth 申请?),会去知乎专栏里宣传一波的。

## 使用

### 安装

```bash
pip install -U zhihu_oauth
```

如果安装遇到问题,请查看文档:[安装][rtds-install]

### 登录

请参见文档:[登录][rtds-login]

### 获取基础信息

代码:

```python
from zhihu_oauth import ZhihuClient

client = ZhihuClient()

client.load_token('token.pkl')

me = client.me()

print('name', me.name)
print('headline', me.headline)
print('description', me.description)

print('following topic count', me.following_topic_count)
print('following people count', me.following_topic_count)
print('followers count', me.follower_count)

print('voteup count', me.voteup_count)
print('get thanks count', me.thanked_count)

print('answered question', me.answer_count)
print('question asked', me.question_count)
print('collection count', me.collection_count)
print('article count', me.articles_count)
print('following column count', me.following_column_count)
```

输出:

```text
name 7sDream
headline 二次元普通居民,不入流程序员,http://0v0.link
description 关注本AI的话,会自动给你发私信的哟!
following topic count 35
following people count 101
followers count 1294
voteup count 2493
get thanks count 760
answered question 258
question asked 18
collection count 9
article count 7
following column count 11
```

更多功能请参见文档:[使用方法][rtds-usage]

## 文档

完整的文档可以在[这里][rtds-home]。

貌似 ReadTheDocs 在伟大的国家访问速度有点慢,建议自备手段。

## TODO

- [x] 将 oauth2.setting 中的 API URL 放到其他合适的地方
- [x] 规范化,`__init__` 函数,`__all__` 变量,import 方式
- [x] CLIENT_ID 和 SECRET 可自定义,为知乎开放 API 申请做准备
- [x] 增加从 id 构建相应类的方法
- [x] 添加与 zhihu-py3 的速度对比
- [x] answer.save 和 article.save
- [x] 打包成模块,发布到 PyPI
- [x] 用户文档
- [x] 内部实现文档(其实就是注释)
- [x] 提供统一的 from_url 用于构建对象
- [x] people.activities 用户动态
- [x] Me 类的各种操作,比如评论,点赞,私信……etc
+ [x] 点赞/[反对]/清除
- [x] 答案
- [x] 文章
- [x] 评论
+ [x] 感谢/清除
+ [x] 没有帮助
+ [x] 关注/取消关注
- [x] 问题
- [x] 话题
- [x] 用户
- [x] 专栏
- [x] 收藏夹
+ [x] 屏蔽/取消屏蔽用户
+ [x] 收藏答案
+ [x] 私信
+ [x] 评论
- [x] 答案
- [x] 文章
- [x] 问题
- [x] 收藏夹
- [x] 回复评论
+ [x] 删除
- [x] 答案
- [x] 评论
- [x] 收藏夹
- [x] 文章
- [ ] 获取用户消息。新关注者,新评论,关注的回答有新问题,有私信等。
- [ ] 规范的测试
- [ ] 保证对 Python 2 和 3 的兼容性
- [ ] article.voters 文章点赞者,貌似 OAuth2 没有这个 API
- [ ] collection.followers 这个 API 不稳定,没法返回所有关注者

## LICENSE

MIT


[zhihu-py3-github]: https://github.com/7sDream/zhihu-py3
[speed-compare]: https://github.com/7sDream/zhihu-oauth/blob/master/compare.md
[changelog]: https://github.com/7sDream/zhihu-oauth/blob/master/changelog.md

[rtds-home]: http://zhihu-oauth.readthedocs.org/zh_CN/latest
[rtds-install]: http://zhihu-oauth.readthedocs.org/zh_CN/latest/guide/install.html
[rtds-login]: http://zhihu-oauth.readthedocs.org/zh_CN/latest/guide/login.html
[rtds-usage]: http://zhihu-oauth.readthedocs.org/zh_CN/latest/guide/use.html

[badge-author]: https://img.shields.io/badge/Author-7sDream-blue.svg
[badge-docs]: https://readthedocs.org/projects/zhihu-oauth/badge/?version=latest
[badge-version]: https://img.shields.io/pypi/v/zhihu_oauth.svg
[badge-py-version]: https://img.shields.io/pypi/pyversions/zhihu_oauth.svg
[badge-state]: https://img.shields.io/pypi/status/zhihu_oauth.svg
[badge-license]: https://img.shields.io/pypi/l/zhihu_oauth.svg

[my-zhihu]: https://www.zhihu.com/people/7sdream
[pypi]: https://pypi.python.org/pypi/zhihu_oauth
[license]: https://github.com/7sDream/zhihu-oauth/blob/master/LICENSE

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for zhihu_oauth, version 0.0.6
Filename, size File type Python version Upload date Hashes
Filename, size zhihu_oauth-0.0.6-py2.py3-none-any.whl (47.5 kB) File type Wheel Python version 3.5 Upload date Hashes View hashes
Filename, size zhihu_oauth-0.0.6-py3.5.egg (106.7 kB) File type Egg Python version 3.5 Upload date Hashes View hashes
Filename, size zhihu_oauth-0.0.6.tar.gz (42.7 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page