README.md

项目简介

科技赋能创作星辰。

JRT 是一个简书数据获取与分析库，致力于用更简单的方式，帮助有编程基础的用户快速进行数据分析，助力社区成长。

该库基于简书官方接口。

安装

自动安装

JRT 已上传到 PyPI，可使用以下命令自动安装：

pip install JianshuResearchTools

手动安装

您亦可以手动下载项目源代码，使用 setup.py 将其安装到您的设备上。

同时，您还需要运行以下命令，下载 JRT 的依赖库：

pip install httpx lxml

您可运行以下代码示例，确认 JRT 已在您的设备上正常安装：

import JianshuResearchTools as jrt
print(jrt.__version__)

如果一切正常，您会看到 JRT 的版本号。

快速上手

函数调用

示例一，获取用户昵称：

>>> import JianshuResearchTools as jrt
>>> jrt.user.GetUserName("https://www.jianshu.com/u/ea36c8d8aa30")
'初心不变_叶子'

示例二，获取文章标题：

>>> import JianshuResearchTools as jrt
>>> jrt.article.GetArticleTitle("https://www.jianshu.com/p/2c2b76a1d0ae")
'你好，简书贝'

面向对象

示例一，获取用户昵称：

>>> import JianshuResearchTools as jrt
>>> user = jrt.objects.User("https://www.jianshu.com/u/ea36c8d8aa30") 
>>> user.name
'初心不变_叶子'

示例二，获取用户信息摘要：

>>> import JianshuResearchTools as jrt
>>> user = jrt.objects.User("https://www.jianshu.com/u/ea36c8d8aa30")
>>> print(user)
用户信息摘要：
昵称: 初心不变_叶子
URL: https://www.jianshu.com/u/ea36c8d8aa30
性别: 1
关注者数: 388
粉丝数: 1094
文章数: 159
总字数: 316169
简书钻: 15122.726
简书贝: 4877.274
总资产: 20000.0
徽章: 简书创作者 岛主 社区守护者
最后更新时间: 2022-02-02 08:29:26
会员等级: None
会员过期时间: None
个人简介:

依赖库

必须依赖

• httpx：用于实现网络请求
• lxml：用于实现基于 Xpath 的 HTML 解析

可选依赖

• ujson：安装后在大量数据获取场景将获得一定性能提升
• tomd：安装后可以使用 jrt.article.GetArticleMarkdown() 函数获取 Markdown 格式的文章内容

贡献

详见贡献指南文件。（CONTRIBUTING.md）