Text Insight CLI

一个轻量的 Python 文本分析工具。它可以读取 UTF-8 文本文件，统计字符、单词、句子、段落和词频，并把结果输出为终端文本、JSON 或 Markdown 报告。

这个项目只使用 Python 标准库，适合作为课程作业中的小型开源代码库示例。

功能

• 统计字符数、非空白字符数、单词数、去重单词数、句子数、段落数和行数
• 计算平均词长与词汇多样性
• 支持自定义停用词文件
• 显示出现频率最高的若干单词
• 支持终端文本、JSON 和 Markdown 三种输出格式
• 对空文件、文件不存在和非 UTF-8 文件给出清楚的错误提示

环境要求

• Python 3.10 或更高版本
• 无第三方运行依赖

快速开始

在项目根目录执行：

python -m pip install -e .
text-insight examples/sample.txt

输出 Markdown 报告：

text-insight examples/sample.txt --format markdown --output report.md

使用停用词并显示前 8 个高频词：

text-insight examples/sample.txt --stopwords examples/stopwords.txt --top 8

也可以不安装，直接运行：

python -m text_insight examples/sample.txt --format json

运行测试

python -m unittest discover -s tests -v

项目结构

text-insight-cli/
├─ examples/
│  ├─ sample.txt
│  └─ stopwords.txt
├─ src/text_insight/
│  ├─ analyzer.py
│  ├─ cli.py
│  └─ reporters.py
├─ tests/
├─ LICENSE
├─ README.md
└─ pyproject.toml

为什么选择 MIT License

这个工具规模不大，主要用途是学习、交流和复用。我希望别人可以直接修改或放进自己的练习项目，因此选择限制较少、条款简洁的 MIT License。使用者只需保留版权与许可声明；许可证中的免责声明也明确了维护者的责任边界。

License

本项目采用 MIT License，完整条款见 LICENSE。