supermemo-toolkit(smtk)

SuperMemo 增强工具(CLI命令行)。包含图链整理、EPUB图书转换导入、Latex公式转图片、sm2anki、修补导出标题乱码等。

1. Install

pipx：“python 系统”下的 whl 格式软件包安装管理器。pipx 安装应用请务必联网。

推荐的安装方式是 pipx，pipx 可以理解为 Android 系统的应用程序管理器，而 whl 类比为安卓的 apk 应用。pipx 就是用来安装和管理 whl 格式的 python 软件包。其次，你可以下载源代码的方式，本地构建一个软件开发环境运行，这样做的任务复杂度带来的试错成本略高，需要安装 py、uv，然后使用 uv 安装依赖，配置好后才可以开始使用。

1.1 安装&更新：

1. 安装 Python，版本 ≥ 3.10 即可
2. 安装 pipx 应用安装管理器（使用 pip 安装）：
   1. python3 -m pip install --user pipx
   2. python3 -m pipx ensurepath
3. 下载supermemo_toolkit-py3-none-any.whl
4. 执行pipx install supermemo_toolkit-py3-none-any.whl等待安装成功。
   1. 关于更新
      1. 同样使用 pipx 应用安装管理器
      2. 执行pipx install --force save-path/your-app.whl
      3. 显示成功后即可更新成功。
5. 安装成功后，可以执行smtk命令验证是否安装成功。（可能需要重启终端）
6. 设置 smtk config。
   1. 设置 sm 程序所在路径，软件需要查找和读取 sm 自动存储的 systems 集合
   2. 用法：smtk config set program 'sm.exe所在路径'
   3. 例子：smtk config set program 'D:\SuperMemo'，比如我的sm.exe在D:\SuperMemo路径下。
7. 然后就可以正常使用了，请继续阅读下列功能使用说明。

1.2 遇到的问题

遇到的问题 1：若出现 ERROR: No matching distribution found for XXX，一般是网络问题，切换 PYPI 源即可，可以使用下列方式切换 PYPI 源。

# 切换阿里源
pip config set global.index-url http://mirrors.aliyun.com/pypi/simple/
pip config set install.trusted-host mirrors.aliyun.com
# 换回默认源
pip config unset global.index-url

遇到的问题 2：执行python3 -m pip报错：No module named 'pip'，可以通过下列方式解决。

python -m ensurepip

python -m pip install --upgrade pip

遇到的问题 3：supermemo 只支持五种图片格式："image/jpeg"、"image/jpg"、"image/png"、"image/gif"、"image/bmp"，PathPix 功能只支持网络图片转换为受支持的五类图片，本地暂时不支持。E2SM 功能只对书籍图片进行复制，暂时不支持图片转换为受支持的五类图片格式。

2. PathPix

supermemo 图链整理工具。

PathPix：任意类型的网络图片整理为受支持的五种格式的图片，并网络和本地图片收集起来转换为相对路径，存放在 elements 文件夹中。其中，网页内嵌图片由 pathpix 管理，元素注册表图片由图片注册表管理。pathpix 管理的图片文件，可以导入图片注册表中。

详细问题请查看：旧版 Pathpix 文档：https://docs.qq.com/doc/DQnRpb0VNUEVvR3dl

致谢：● 兰迥 ●Merlin ● 水流众生 ●st ●aicling

2.1 整理图片

1. 打开终端
   1. WIN R 打开 CMD 或者 PowerShell，输入命令：smtk。
   2. 或者 shift+鼠标右键->在此处打开 PowerShell 窗口。
2. 设置 SuperMemo 路径
   1. smtk config set program “SM软件路径”
   2. 路径范例：C:\\Users\\Snowy\\Desktop\\sm18，注意是 sm18.exe 程序的根路径，就是 sm18.exe 所在的目录。不要这样写：C:\\Users\\Snowy\\Desktop\\sm18\\sm18.exe
3. 使用smtk clist列出集合。若未列出集合一般是软件路径未设置正确、或者没有使用 SuperMemo 默认存放集合的 System 路径位置。
4. 使用smtk pathpix <集合名字>整理集合图片
   1. 比如smtk pathpix "ALL IN ONE" 就可以让程序按照策略进行整理了。
   2. 也可以使用smtk pathpix --least-col整理最后一次使用的集合。

3. E2SM

从 epub 图书生成 xml 格式的 sm-book 图书。

生成的图书会包含 XML 格式图书 和 书籍图片文件夹 两个内容。需要生成的书籍图片文件夹放到 SM 集合的your_collection/elements/local_pic文件夹下，如果你不需要的图片显示的话，可以不用放。一般情况下集合默认全路径为：Root_SuperMemo/systems/your_collection。

3.1 使用方法

例如我想将“如何阅读一本书.epub”文件转换为可导入的 supermemo 集合文件（XML+图片附件文件夹）

1. 执行转换命令：按顺序生成 smtk e2sm --linear <epub_file> <out_folder> （这个命令的含义是图书按照前后顺序转换为一系列 Topic 列表）
   • 使用比较简单，对于 win10 及以上版本的系统，可以在桌面-右单击-使用终端打开
   • 在终端中输入smtk e2sm --linear 如何阅读一本书.epub C:\Users\Name\Desktop
   • 按 Enter 键执行此命令，稍后会在桌面生成一个 XML 文件和对应的书籍图片文件夹。
2. 把“书籍图片文件夹”放到对应的位置
   • 文件夹需要放置到上文说的指定的位置
   • 因为程序在处理过程会自动将绝对路径转换为固定的相对路径，这个路径在转换后的 XML 文件中是写好的。
3. 导入生成的 XML 图书到 SuperMemo
   • 打开 supermome 软件，点击菜单按钮：File - Import - XML
   • 在打开的对话框中选择转换好的电纸书 XML 集合文件，点击导入。
   • 导入成功的同时就可以看到最终的效果了。

3.2 更多的转换方式

• 按目录生成 smtk e2sm --toc <epub_file> <out_folder>
  • 需要图书有良好的目录，若没有，需使用 calibre 生成并整理目录
• 按顺序生成 smtk e2sm --linear <epub_file> <out_folder>
  • 有书即可，不按照 EPUB 目录文件生成，而是按照 EPUB 图书内文档文件的线性顺序生成，比较适合 PDF 版 epub，效果查看文件：./docs/Snipaste_2024-03-24_09-17-23.png
• 按单个 Topic 生成 smtk e2sm --topic <epub_file> <out_folder>
  • 有书即可，EPUB 转换为一个 SuperMemo Topic，一本书即是一篇文章，配合 SuperMemo 阅读点使用更佳。
• 按单个 Topic 生成，按长度分片并插入HR标签 smtk e2sm --topic --limit 1500 <epub_file> <out_folder>
  • 在单个TopicEpub中按照限制字数（例如1500字）在段后插入hr标签
  • 使用SuperMemo的split article进行分割得到图书分片。

4. latex2img

• latex 公式转图片。
  • 用法：smtk imtex <formula_text> <outpath>
  • 例子：smtk imtex "$\sum_{i=0}^\infty x_i$" ./a.png
  • 说明：将数学公式$\sum_{i=0}^\infty x_i$保存到./a.png

5. sm2anki

打开 supermemo，选择要导出的分支::右单击::导出（Export）::Q&A text file，然后弹出一个选择对话框，默认即可，随便选择。

• 第二个选项 Allow HTML 选项是导出 HTML 片段，到 ANKI 中可以有挖空的高亮效果。
• 第二个选项不用管。用于筛选的。
• 第三个选项是导出 Title 标题，用不着。
• 第四个选项是包含 Element ID，这个 ID 可以使用 Ctrl + G 输入 ID 后跳转的元素。

需要打开 Anki，并且安装 ankiconnect 插件。

• 使用方式：smtk sm2anki <qafile> [--deckname "your_deskName"]
  • 使用默认牌组 smtk sm2anki "docs/TEQA.htm"
    • 默认牌组是 TEQA Cards，默认的模版是 TEQA 问答题，包含字段：Title、Element、Question、Answer。
  • 使用自定义牌组 smtk sm2anki "docs/TEQA.htm" --deckname "your_deskName"
    • 自定义牌组 your_deskName

6. tcomp

修补导出Source code或者XML文件标题乱码或缺失。

1. 选定需要导出的分支
2. 导出选定分支的知识树 HTM-TOC 文件。
   1. 使用 知识树右键菜单>>Export>>Document>>Document export options:Knowledge tree in a single file
3. 导出 Source code 或者 XML 文件。
   1. 使用 知识树右键菜单>>Export>>Source code
   2. 使用 知识树右键菜单>>Export>>XML
4. 使用 HTM-TOC 修补导出的 Source code 或者 XML 文件。
   1. smtk tcomp htmtocfile --node nodefile
      1. 为避免Source code乱码，程序采用下划线代替空格并包裹数字
   2. smtk tcomp htmtocfile --xml xmlfile

关于开发

依赖模块 python_lzo-1.16 包含 C/C++模块，构建时会链接到特定版本的 Python 运行库，由于 pypi 已经许久未更新，所以通过 fork 后执行 action 构建离线包，对应版本的离线包已放置到 docs\python_lzo_win_amd64，使用时请根据自己的 python 版本修改 pyproject.toml

LICENSE

本软件遵守开源协议，协议类型为：GPLv2。

Star History

赞助

当您见证自己用SuperMemo坚持两年后阅读量飙升的喜悦，请记得这份坚持背后有smtk在默默护航——它不仅是市面上唯一能修复标题乱码、集合图片整理修复、无缝导入EPUB图书的工具箱，更是您学习路上最懂你的战友。您的赞助，将点亮更多孤独求索者的学习之路，让每一份坚持都收获更温暖的回报。

致谢：NEXT，郁蒸十四，但为君故-sm18tb8