Zotero-arXiv-Daily 项目安装与配置指南
1. 项目基础介绍
Zotero-arXiv-Daily 是一个开源项目,旨在帮助用户根据其 Zotero 文献库推荐并获取每天发布的 arXiv 论文。项目通过分析 Zotero 文献库中的论文,与 arXiv 上新发布的论文进行匹配,并将相关论文信息通过电子邮件的形式发送给用户。
该项目主要使用的编程语言是 Python。
2. 项目使用的关键技术和框架
- Zotero API:用于访问用户的 Zotero 文献库。
- arXiv API:用于获取 arXiv 上的最新论文。
- SMTP:用于发送电子邮件。
- 轻量级语言模型(LLM):用于生成论文的 TL;DR 摘要。
- GitHub Actions:用于自动化工作流程,无需本地运行环境即可执行任务。
- Gitignore:用于定义 Zotero 文献库中需要忽略的集合。
3. 项目安装和配置的准备工作
在开始安装和配置之前,请确保您已经满足以下条件:
- 安装了 Git。
- 注册了 Zotero 账号并创建了至少一个文献库。
- 获取了 Zotero API 的密钥。
- 注册了 arXiv 账号(如果需要)。
- 准备了一个用于发送邮件的邮箱账号及其 SMTP 服务器设置。
- 安装了 Python(如果需要在本地运行)。
安装步骤
步骤 1:克隆项目
首先,您需要克隆项目到本地计算机:
git clone https://github.com/TideDra/zotero-arxiv-daily.git
cd zotero-arxiv-daily
步骤 2:设置环境变量
在项目的根目录下,您需要设置一些环境变量。这些变量包括 Zotero 用户 ID、API 密钥、SMTP 服务器信息等。创建一个 .env
文件并添加以下内容:
ZOTERO_ID=您的Zotero用户ID
ZOTERO_KEY=您的Zotero API密钥
ARXIV_QUERY=您感兴趣的arXiv分类,例如:cs.AI+cs.CV
SMTP_SERVER=您的SMTP服务器地址
SMTP_PORT=您的SMTP服务器端口
SENDER=发件人邮箱地址
SENDER_PASSWORD=发件人邮箱密码
RECEIVER=收件人邮箱地址
MAX_PAPER_NUM=邮件中显示的最大论文数量
步骤 3:配置 GitHub Actions
如果您希望在 GitHub Actions 上自动化这一流程,您需要配置相应的 Workflow 文件。在项目的 .github/workflows
目录中,编辑 main.yml
文件,根据您的需求设置触发时间和环境变量。
步骤 4:本地运行(可选)
如果需要在本地运行项目,确保已经安装了 Python 和必要的依赖项。然后,在项目根目录下运行以下命令:
python main.py
步骤 5:测试
无论您是本地运行还是通过 GitHub Actions 运行,都建议在初次配置后测试一下流程是否正常工作。
以上步骤为 Zotero-arXiv-Daily 的基本安装和配置指南,按照这些步骤操作后,您应该能够开始接收每天推荐的 arXiv 论文。