掘金(Juejin) Python SDK

项目简介

occrq-juejin-python-sdk 是一个收集公开的掘金API并封装的Python封装库，部分参数可选值未知，需要自行获取，当前仅提供了部分掘金平台功能接口，包括用户管理、文章操作等功能。

主要特性

• 支持用户签到、排行榜
• 支持文章创建、编辑、删除管理

安装方式

pip install occrq-juejin-python-sdk

依赖版本

Python >= 3.8

快速开始

浏览器获取cookie，如需使用签到功能还需要获取 a_bogus，ms_token，aid, uuid

登录后，进入掘金用户签到页面：https://juejin.cn/user/center/signin?from=sign_in_menu_bar

F12打开浏览器开发者工具，选择Network，刷新页面，搜索check_in_rulers接口：

获取cookie

获取a_bogus，ms_token，aid, uuid

初始化客户端

import juejin
import os
# 初始化客户端(需要从浏览器获取认证信息) 需要使用签到功能时需必须设置AuthConfig

# 使用签到功能时需要初始化auth_config，如不需要使用，不需要初始化和设置
auth_config = juejin.AuthConfig()
auth_config.ms_token = '-='
auth_config.a_bogus = ''
auth_config.aid = '2608'
auth_config.uuid = ''
cookie = ''
client = juejin.JuejinClient(auth_config=auth_config, cookie=cookie)

用户相关操作

获取用户信息

# 获取用户信息
import juejin
import os

# 使用签到功能时需要初始化auth_config，如不需要使用，不需要初始化和设置
auth_config = juejin.AuthConfig()
auth_config.ms_token = '-='
auth_config.a_bogus = ''
auth_config.aid = '2608'
auth_config.uuid = ''
cookie = ''
client = juejin.JuejinClient(auth_config=auth_config, cookie=cookie)

# 打印用户信息
result = client.describe_user_info_package()
print(result)

文章管理

创建一篇草稿

import os
import juejin

from juejin.models import ArticleRequest

# 使用签到功能时需要初始化auth_config，如不需要使用，不需要初始化和设置
auth_config = juejin.AuthConfig()
auth_config.ms_token = '-='
auth_config.a_bogus = ''
auth_config.aid = '2608'
auth_config.uuid = ''
cookie = ''
client = juejin.JuejinClient(auth_config=auth_config, cookie=cookie)
result = client.create_article_draft(ArticleRequest().from_dict(
    {"title": "这是我的第一篇博客"})
)
# 创建草稿
print(f"result")

SDK 文档

describe_user_info_package()

• 描述：获取用户的信息包，包含用户的基本信息、计数信息等。
• 返回：包含用户信息的字典，具体格式取决于掘金 API 的响应。

describe_user_rank_info()

• 描述：获取用户的排行榜信息。
• 返回：包含用户排行榜信息的字典，具体格式取决于掘金 API 的响应。

create_user_check_in()

• 描述：执行用户签到操作。
• 返回：：包含签到结果的字典，具体格式取决于掘金 API 的响应。

describe_user_dynamic()

• 描述：：获取用户的动态信息。
• 返回：包含用户动态信息的字典，具体格式取决于掘金 API 的响应。

create_article_draft(article_request)

• 描述：创建一篇新的文章草稿。
• 参数：
  • article_request (ArticleRequest): 包含文章标题、内容等信息的请求对象。可以使用 ArticleRequest().from_dict({"title": "文章标题"}) 这样的方式构建。
• 返回：包含创建结果的字典，具体格式取决于掘金 API 的响应。

update_article_draft(ArticleRequest)

• 描述：更新一篇已有的文章草稿。
• 参数： req (ArticleRequest): 包含需要更新的文章信息的请求对象。
• 返回：包含更新结果的字典，具体格式取决于掘金 API 的响应。

delete_article_draft(draft_id)

• 描述：删除一篇文章草稿。
• 参数： draft_id (str): 要删除的文章草稿的 ID。
• 返回：包含删除结果的字典，具体格式取决于掘金 API 的响应。

delete_article(id)

• 描述：删除一篇文章。
• 参数： id (str): 要删除的文章的 ID。
• 返回：包含删除结果的字典，具体格式取决于掘金 API 的响应。

publish_article_draft(draft_id)

• 描述：发布一篇文章草稿。
• 参数： draft_id (str): 要发布的文章草稿的 ID。
• 返回：包含发布结果的字典，具体格式取决于掘金 API 的响应。

describe_article_detail(draft_id)

• 描述：获取一篇文章的详细信息。
• 参数： draft_id (str): 要获取详情的文章草稿的 ID。
• 返回：包含文章草稿详细信息的字典，具体格式取决于掘金 API 的响应。

describe_article_detail(req)

• 描述：获取一篇文章的详细信息。
• 参数： req (DescribeArticleDetailRequest): 要获取详情的文章草稿的 ID。
• 返回：包含文章草稿详细信息的字典，具体格式取决于掘金 API 的响应。

describe_article_list(req)

• 描述：获取文章列表。
• 参数： req (DescribeArticleListRequest): 查询参数，例如分页信息、筛选条件等。
• 返回：包含文章列表的字典，具体格式取决于掘金 API 的响应。

describe_article_draft_list(req)

• 描述：获取草稿箱列表。
• 参数： req (DescribeArticleListRequest): 查询参数，例如分页信息、筛选条件等。
• 返回：包含文章列表的字典，具体格式取决于掘金 API 的响应。

贡献指南

欢迎提交Pull Request或Issue报告问题。

许可证

MIT License