跳转到主要内容

Memium

项目描述

Memium

Open in Dev Container PyPI Python Version Roadmap

当你需要停下来查找信息时,它会打断你的流程。将这种知识添加到长期记忆中可以建立流畅性,而精通某事会使它变得更有趣!从爬行到奔跑的速度越快,就越有趣。

不幸的是,我们忘记了大多数我们阅读的东西,即使是我们在意的东西

结果是,如果你对你阅读的文本提出问题,并且在未来自己提出这些问题,你会学到更多!但写问题和自我测试可能感觉相当机械。如果你把问题作为笔记的一部分写下来,然后你的电脑可以在未来测试你,那会怎么样?这就是Memium的目的。它从你的笔记中提取问题,就像

Q. Why can spaced repetition result in more enjoyable learning?
A. It enables faster bootstrapping to proficiency, which is more fun!

并将它们添加到像Anki这样的间隔重复服务中。

这是Andy Matuschak的个人记忆媒介的实现。

用作应用程序

如果您想将markdown笔记同步到Anki,以下是开始的方法!

  1. 在Anki中安装AnkiConnect插件

命令行界面

  1. 使用pipx在独立虚拟环境中安装Memium,
> pipx install memium
  1. 导入您的笔记!
> memium --input-dir [YOUR_INPUT_DIR]

在Docker容器中

  1. 安装Orbstack或Docker Desktop。
  2. 设置容器
$INPUT_DIR="PATH_TO_YOUR_INPUT_DIR"

docker run -i \
  --name=memium \
  -e HOST_INPUT_DIR=$INPUT_DIR \
  -v $INPUT_DIR:/input \
  --restart unless-stopped \
  ghcr.io/martinbernstorff/memium:latest \
  memium \
  --input-dir /input/

这将启动一个docker容器,它将您的牌组从$INPUT_DIR更新。如果有更新的文件,它将同步差异(创建新提示和删除已删除的提示)到Anki。

如果您想持续同步目录,请同时设置--watch-seconds [UPDATE_SECONDS]参数。

保持软件包更新可能有些麻烦,但可以使用WatchTower自动化。

作为库使用

如果您想在此处添加的抽象之上构建自己的Python应用程序,您可以从PyPI安装该库

pip install memium

管道抽象

该库构建成一个如图所示的管道。左侧描述了由接口定义的抽象管道,右侧路径描述了从Markdown到Anki的接口实现,这些在CLI中可用。

graph TD 
	FD["File on disk"]
        DP["Prompts at Destination"]
	FD -- DocumentSource --> Document
	Document -- PromptExtractor --> Prompt
	Prompt -- Destination --> DP
 
	MD["Markdown file"]
	Prompts["[QAPrompt | ClozePrompt]"]
        Anki["Cards in the Anki app"]
 
	MD -- MarkdownDocumentSource --> Document
	Document -- "[QAPromptExtractor, \nClozePromptExtractor]" --> Prompts
        Prompts -- AnkiConnectDestination --> Anki

贡献

设置开发环境

  1. 安装Orbstack或Docker Desktop。在继续之前,请确保完成完整的安装过程。
  2. 如果没有安装,请安装VSCode
  3. 点击此链接
  4. 完成设置过程

提交PR

欢迎提交拉取请求!如果您想在本地运行整个管道,请运行

inv validate_ci

💬 哪里提问

类型
🚨 错误报告 GitHub问题跟踪器
🎁 功能请求和想法 GitHub问题跟踪器
👩‍💻 使用问题 GitHub讨论
🗯 一般讨论 GitHub讨论

项目详情


下载文件

下载适用于您的平台的文件。如果您不确定选择哪一个,请了解更多关于安装软件包的信息。

源分布

memium-0.21.3.tar.gz (98.9 kB 查看哈希值)

上传时间

构建分布

memium-0.21.3-py3-none-any.whl (44.9 kB 查看哈希值)

上传时间 Python 3

支持者

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误记录 StatusPage StatusPage 状态页面