Skip to content

shiquda/wereadcard

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

wereadcard

简介

本项目利用 Github Actions 自动抓取微信读书记录,并且生成 .svg 卡片,作为展示。

本项目尚处初期,卡片的内容和样式较为简陋,欢迎PR共同改进。

卡片预览效果:

卡片预览

使用

使用 Github Actions

cookie 获取

这里仅演示一种方法:

进入https://weread.qq.com/,扫码登陆微信读书。

使用F12控制台工具,打开网络/Network,刷新页面,筛选Fetch/XHR,任意选中一个请求,然后在标头/Header处找到Cookie,完整复制对应的字符串。

cookie获取演示

Github 配置

  1. fork本仓库。
  2. 在你的仓库,进入Settings > Secrets and variables > Actions,添加 Repository secrets
  3. 【必填】:WEREAD_COOKIE,添加上一步复制的微信读书cookie字符串
  4. 【非选填】:BOOK_COUNT,默认为4,图片上展示的图书数量,建议不超过5。.
  5. 进入Settings > Actions > General,找到Workflow permissions,改为选择Read and write permissions,并点击Save保存。

现在Github Actions默认会每间隔8个小时更新一次图像,并推送至仓库。更新的卡片在/output/recent_read.svg可以找到。

当然,你也可以手动触发Actions。

获取图片直链

在GitHub进入图片,Raw对应的就是直链链接。如果网络环境不好的,可以考虑使用镜像站加速,将URL中的githubusercontent替换为kkgithub,如:

https://raw.githubusercontent.com/shiquda/wereadcard/main/output/recent_read.svg

替换为

https://raw.kkgithub.com/shiquda/wereadcard/main/output/recent_read.svg

本地使用

克隆本仓库,然后安装依赖:

pip install -r requirements.txt

支持三种使用方式:

可以直接在main.py中配置cookie等参数,然后直接运行。

或者使用命令行参数:

  • --cookie, -c:cookie字符串,注意在字符串两端加上引号。
  • --number, -n:生成卡片中图书的数量。

或者参照.env.example 配置 .env 文件。

优先级:命令行参数 > .env > main.py 中直接配置变量

运行后生成的卡片在/output目录中。

TO-DO

  • 添加阅读进度展示
  • 添加总阅读时长、阅读书目等展示
  • 美化样式

致谢

About

微信读书卡片生成器

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages