pyTreeHole

Deprecation Notice : Because tree holes frequently change APIs and recently introduced mandatory web UUID SMS verification, I no longer have the energy to maintain this project, so it will be abandoned. If you are interested in continuing to develop this project, you can continue to PR and contact me, or publish it to a new package name. Thanks again to everyone who has used and helped with development.

---

Important notice! ! : Because the original tree hole changed the authentication method and request address, the versions before v2.0.0 of this package are unavailable. Please update your project to v2.0.0 and above in time.

See below for the new version of tree hole authentication method

---

TreeHole

A simple Python interface to PKU Tree Hole

It is currently under continuous development and improvement, and we welcome the use and suggestions!

Highlights

• Simple and easy to use
• Complete documentation
• token login
• Python 3.6+
• Support asynchronous requests
• Automatically process image url
• All tree hole data models are encapsulated as data classes
• Cover (almost?) all business logic exposed to users

Install

Published to Pypi source, you can install it directly using pip:

pip3 install TreeHole

use

Authentication

You have two ways to verify your identity:

1. Log in with username and password (not recommended)

   You can pass in uid (student number) and password (password) parameters when instantiating TreeHoleClient , and log in with the IAAA account.

2. Log in with token (recommended, relatively safe)

   For how to obtain a tree hole token, please refer to @Guyutongxue's operating instructions (i.e. "Beida Tree hole JWT" in this instruction), you can also find it in the pku_token field in the browser's cookies.

Code Example

 from treehole import TreeHoleClient

# 使用 token 认证
client = TreeHoleClient ( token = < Your Token > )
# 使用 IAAA 账号认证
client = TreeHoleClient ( uid = < UID > , password = < Password > )
# 获取单个树洞
hole = client . get_hole ( < Hole ID > )
# 获取树洞评论
comments = client . get_comment ( < Hole ID > )
# 获取首页树洞列表
holes = client . get_holes ( < Page Num > )
# 获取关注树洞列表
holes = client . get_followed ( < Page Num > )
# 切换关注状态
success , status = client . post_toggle_followed ( < Hole ID > )
# 发布树洞
success = client . post_hole ( < Text > , < Image File > )
# 发布评论
success = client . post_comment ( < Hole ID > , < Text > , < Reply To > )
# 举报树洞 (!!!!!! 请勿轻易尝试)
success = client . post_report ( < Hole ID > , < Reason > )

Please refer to non-asynchronous and asynchronous use cases

Development

Clone this repository:

git clone [email protected]:TeddyHuang-00/pyTreeHole.git

In editing mode:

pip3 install -e " .[test] "

Welcome to issue and PR!

Roadmap

• Support new version of tree holes
• Support IAAA account login
• Tree hole data model
• Client encapsulation
• Get a single tree hole
• Get the home page tree hole
• Get attention to tree holes
• Get a tree hole reply
• Follow/Retouch Tree Cave
• Reply to the tree hole
• Publish tree hole
• Report a tree hole
• Support asynchronous processing
• Supports custom loading length
• More features to be added...