blampe/rreading-glasses

读者矫正镜片工具镜像

一、镜像概述和主要用途

本镜像为一款专注于提升文本可读性的工具容器化实现，旨在为存在阅读障碍、对复杂文本耐心有限或需要快速理解内容的用户（喻指“脾气坏的读者”）提供“矫正镜片”式的文本处理能力。通过自动化分析与转换，将晦涩、冗长或格式混乱的文本转换为简洁、结构化、易读的形式，降低阅读门槛，提升信息获取效率。

二、核心功能和特性

核心功能

1. 文本复杂度简化：自动识别并拆分长句、简化复杂词汇，保留核心语义；
2. 格式标准化：支持将非结构化文本（如纯文本、Markdown、HTML片段）转换为统一格式（如分段、加粗标题、项目符号列表）；
3. 自定义规则适配：允许通过配置文件定义简化规则（如专业术语替换、句式偏好）；
4. 多格式输入输出：支持TXT、Markdown、PDF（基础文本提取）作为输入，输出格式包括TXT、HTML、结构化JSON。

特性

• 轻量级：基于Alpine Linux构建，镜像体积<50MB；
• 无状态设计：单次任务处理，无需持久化存储；
• 高性能：内置多线程文本处理引擎，支持批量文件处理；
• 兼容性：支持Linux/Windows/macOS的Docker环境。

三、使用场景和适用范围

适用场景

1. 学术/技术文档阅读辅助：将冗长的论文摘要、技术手册简化为要点式内容；
2. 老年人/阅读障碍者辅助工具：降低文本复杂度，适配简易阅读习惯；
3. 快速信息筛选：从大量非结构化文本（如日志、邮件）中提取关键信息；
4. 内容二次加工：将原始文本转换为适配特定平台（如公众号、知识库）的格式。

适用范围

• 个人用户：本地文本处理、阅读效率提升；
• 企业/团队：内部文档标准化、客户资料简化；
• 开发集成：作为微服务组件嵌入文本处理流水线（需通过API模式运行，见“高级配置”）。

四、使用方法和配置说明

基础使用（命令行模式）

1. 拉取镜像

bash
docker pull [镜像仓库地址]/reader-corrective-lens:latest  # 替换为实际镜像仓库地址

2. 单次文本处理（文件输入输出）

将本地文本文件挂载至容器，指定输入/输出路径及处理规则：

bash
docker run --rm -v /local/input:/input -v /local/output:/output \
  [镜像仓库地址]/reader-corrective-lens:latest \
  process \
  --input /input/source.txt \  # 输入文件路径（容器内路径）
  --output /output/result.md \ # 输出文件路径（容器内路径）
  --simplify-level medium \    # 简化级别：low/medium/high
  --output-format markdown     # 输出格式：txt/markdown/html/json

3. 直接处理字符串（标准输入输出）

通过管道传入文本，直接输出处理结果：

bash
echo "The quick brown fox jumps over the lazy dog. This sentence is an example of a pangram." | \
docker run --rm -i [镜像仓库地址]/reader-corrective-lens:latest \
  process --input - --output - --simplify-level high

配置参数说明

1. 命令行参数

2. 环境变量

通过-e指定环境变量，覆盖默认行为：

3. 自定义规则配置

通过挂载YAML配置文件（--config参数指定路径）定义文本处理规则，示例：

yaml
# /local/config/rules.yaml
replace:
  - pattern: "人工智能"       # 匹配文本
    target: "AI"             # 替换为
    case_sensitive: false    # 是否区分大小写（默认false）
simplify:
  max_sentence_length: 20    # 最长句长（超过则拆分，默认30字）
  keep_technical_terms: true # 是否保留专业术语（默认false）

使用自定义规则的命令示例：

bash
docker run --rm -v /local/input:/input -v /local/output:/output -v /local/config:/config \
  [镜像仓库地址]/reader-corrective-lens:latest \
  process \
  --input /input/tech-doc.txt \
  --output /output/simplified-doc.md \
  --config /config/rules.yaml

五、部署方案示例

Docker Compose配置（批量处理服务模式）

如需长期运行并监听目录自动处理文件，可通过docker-compose配置挂载监控目录：

yaml
# docker-compose.yml
version: '3'
services:
  reader-lens:
    image: [镜像仓库地址]/reader-corrective-lens:latest
    volumes:
      - ./watch-input:/input  # 监控此目录下的新文件
      - ./watch-output:/output # 处理结果输出至此目录
      - ./config:/config      # 自定义规则配置
    environment:
      - DEFAULT_SIMPLIFY_LEVEL=medium
      - LOG_LEVEL=info
    command: watch --input /input --output /output --config /config/rules.yaml  # 启动目录监控模式

启动服务：

bash
docker-compose up -d

注：watch命令为镜像提供的目录监控模式，当/input目录新增文件（支持.txt/.md/.pdf）时，自动触发处理并输出至/output目录，文件名与输入保持一致，后缀按DEFAULT_OUTPUT_FORMAT（默认md）调整。