ReadingListReader 项目教程

ReadingListReader 项目教程

ReadingListReaderPython library to read contents of Safari Reading List. Includes scripts to output as CSV or "bookmarks" file format and to upload to Instapaper.项目地址:https://gitcode.com/gh_mirrors/re/ReadingListReader

1. 项目的目录结构及介绍

ReadingListReader 项目的目录结构如下：

ReadingListReader/
├── README.md
├── LICENSE
├── readinglistlib/
│   ├── __init__.py
│   └── readinglistlib.py
├── readinglistreader.py
├── readinglist2instapaper.py
├── readinglist2html.py
└── examples/
    └── example.py

• README.md: 项目说明文档。
• LICENSE: 项目许可证文件。
• readinglistlib/: 包含核心库文件的目录。
  • __init__.py: 初始化文件。
  • readinglistlib.py: 核心库文件，用于读取 Safari 阅读列表。
• readinglistreader.py: 主启动文件，用于读取和显示阅读列表。
• readinglist2instapaper.py: 用于将阅读列表导出到 Instapaper 的脚本。
• readinglist2html.py: 用于将阅读列表导出为 HTML 文件的脚本。
• examples/: 示例脚本目录。
  • example.py: 示例脚本。

2. 项目的启动文件介绍

项目的启动文件是 readinglistreader.py。该文件的主要功能是读取 Safari 阅读列表并显示其中的文章。以下是该文件的基本使用方法：

from readinglistlib import ReadingListReader

rlr = ReadingListReader()
rl = rlr.read()

for article in rl:
    print(article['title'], article['url'])

3. 项目的配置文件介绍

ReadingListReader 项目没有专门的配置文件。所有的配置选项都可以通过命令行参数或脚本中的参数进行设置。以下是一些常用的命令行参数：

• --show: 控制显示的阅读列表项，可选值为 unread、read 或 all，默认为 unread。
• --sortfield: 控制输出的排序字段，可选值为 title、url、date 等，默认为 date。
• --sortorder: 控制排序顺序，可选值为 ascending 或 descending，默认为 ascending。

例如，以下命令将显示所有已读的阅读列表项，并按标题降序排列：

python readinglistreader.py --show read --sortfield title --sortorder descending

通过这些参数，用户可以根据自己的需求灵活地配置和使用 ReadingListReader 项目。

ReadingListReaderPython library to read contents of Safari Reading List. Includes scripts to output as CSV or "bookmarks" file format and to upload to Instapaper.项目地址:https://gitcode.com/gh_mirrors/re/ReadingListReader