提交文件

Author: Doow501

.github/workflows/ci.yml

@@ -0,0 +1,62 @@
+name: CI
+
+on:
+  push:
+    branches: [ main, master ]
+  pull_request:
+    branches: [ main, master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.9', '3.10', '3.11', '3.12']
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e ".[dev]"
+
+    - name: Lint with ruff
+      run: |
+        pip install ruff
+        ruff check src/ tests/ --exit-zero
+
+    - name: Run tests
+      run: |
+        pytest tests/ -v --tb=short
+
+  build:
+    runs-on: ubuntu-latest
+    needs: test
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.11'
+
+    - name: Install build tools
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+
+    - name: Build package
+      run: python -m build
+
+    - name: Upload artifacts
+      uses: actions/upload-artifact@v4
+      with:
+        name: dist
+        path: dist/

.gitignore

@@ -0,0 +1,77 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# macOS
+.DS_Store
+
+# Project specific
+realcite.yaml
+*.log
+output/
+reports/
+.cache/

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 RealCite Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -0,0 +1,69 @@
+.PHONY: install dev test lint format build clean help
+
+# 默认目标
+help:
+	@echo "RealCite - 学术文献引用真实性检测工具"
+	@echo ""
+	@echo "可用命令:"
+	@echo "  make install    安装项目"
+	@echo "  make dev        安装开发依赖"
+	@echo "  make test       运行测试"
+	@echo "  make lint       代码检查"
+	@echo "  make format     代码格式化"
+	@echo "  make build      构建发布包"
+	@echo "  make clean      清理临时文件"
+	@echo "  make demo       运行示例演示"
+	@echo ""
+
+# 安装
+install:
+	pip install -e .
+
+# 安装开发依赖
+dev:
+	pip install -e ".[dev]"
+
+# 运行测试
+test:
+	pytest tests/ -v
+
+# 快速测试（失败即停）
+test-fast:
+	pytest tests/ -v -x --ff
+
+# 代码检查
+lint:
+	ruff check src/ tests/
+
+# 代码格式化
+format:
+	black src/ tests/
+	ruff check --fix src/ tests/
+
+# 构建发布包
+build:
+	python -m build
+
+# 清理临时文件
+clean:
+	rm -rf build/ dist/ *.egg-info
+	rm -rf .pytest_cache/ .ruff_cache/
+	find . -type d -name __pycache__ -exec rm -rf {} + 2>/dev/null || true
+	find . -type f -name "*.pyc" -delete 2>/dev/null || true
+
+# 运行示例演示
+demo:
+	@echo "=== 验证真实文献 ==="
+	realcite tests/fixtures/valid.bib -v
+	@echo ""
+	@echo "=== 验证虚假文献 ==="
+	realcite tests/fixtures/fake.bib -v
+	@echo ""
+	@echo "=== 验证混合文献 ==="
+	realcite tests/fixtures/mixed.bib -v
+
+# 验证示例文件
+demo-sample:
+	realcite examples/sample.bib -v -o examples/report.md
+	@echo ""
+	@echo "报告已保存到 examples/report.md"

README.md

@@ -0,0 +1,160 @@
+# RealCite
+
+学术文献引用真实性检测工具 - 检测AI幻觉产生的虚假引用
+
+[English](README_EN.md) | 中文
+
+## 这个工具是干什么的？
+
+当你使用ChatGPT等AI工具辅助写论文时，AI可能会"编造"一些不存在的参考文献（这叫AI幻觉）。RealCite可以自动检测你的BibTeX文件中的引用是否真实存在。
+
+## 从零开始运行（3步）
+
+### 第1步：创建Python环境
+
+```bash
+# 使用conda创建新环境（推荐Python 3.9+）
+conda create -n realcite python=3.11 -y
+conda activate realcite
+```
+
+### 第2步：安装RealCite
+
+```bash
+# 进入项目目录
+cd /data/250010040/workspace/project/realcite
+
+# 安装（开发模式）
+pip install -e .
+```
+
+### 第3步：运行验证
+
+```bash
+# 验证一个BibTeX文件
+realcite your_references.bib
+
+# 或者用我们提供的测试文件试试
+realcite tests/fixtures/valid.bib -v
+```
+
+就这么简单！
+
+## 使用示例
+
+### 命令行使用
+
+```bash
+# 最简单的用法：直接验证
+realcite references.bib
+
+# 保存报告到文件
+realcite references.bib -o report.md
+
+# 输出JSON格式（方便程序处理）
+realcite references.bib -f json -o report.json
+
+# 详细模式（显示验证过程）
+realcite references.bib -v
+
+# 只用特定的验证源
+realcite references.bib --sources dblp,arxiv
+```
+
+### Python代码中使用
+
+```python
+from realcite import RealCite
+
+# 创建验证器
+checker = RealCite()
+
+# 验证BibTeX文件
+report = checker.validate("references.bib")
+
+# 查看结果
+print(f"总共: {report.total_count} 条引用")
+print(f"已验证: {report.verified_count}")
+print(f"可疑: {report.suspicious_count}")
+print(f"未找到: {report.not_found_count}")
+
+# 导出报告
+checker.export_report(report, "report.md", format="markdown")
+```
+
+## 输出结果说明
+
+| 状态 | 含义 |
+|------|------|
+| ✅ 已验证 (verified) | 在学术数据库中找到了匹配的文献 |
+| ⚠️ 可疑 (suspicious) | 找到了部分匹配，但置信度不够高，建议人工核实 |
+| ❌ 未找到 (not_found) | 在所有数据库中都没找到，很可能是虚假引用 |
+| ⛔ 错误 (error) | 验证过程出错（如标题太短无法验证） |
+
+## 验证源说明
+
+RealCite会依次查询以下学术数据库：
+
+| 数据库 | 说明 | 适合验证 |
+|--------|------|----------|
+| DBLP | 计算机科学领域最权威 | CS会议/期刊论文 |
+| Semantic Scholar | AI领域覆盖全面 | AI/ML/NLP论文 |
+| arXiv | 预印本权威来源 | arXiv预印本 |
+| CrossRef | DOI官方数据库 | 有DOI的任何文献 |
+
+## 项目结构
+
+```
+realcite/
+├── src/realcite/          # 源代码
+│   ├── main.py            # 命令行入口
+│   ├── core.py            # 核心验证逻辑
+│   ├── parser.py          # BibTeX解析
+│   ├── matcher.py         # 匹配算法
+│   ├── reporter.py        # 报告生成
+│   └── validators/        # 各数据库验证器
+│       ├── dblp.py
+│       ├── semantic_scholar.py
+│       ├── arxiv.py
+│       └── crossref.py
+├── tests/                 # 测试文件
+│   └── fixtures/          # 测试用的bib文件
+│       ├── valid.bib      # 真实文献
+│       ├── fake.bib       # 虚假文献
+│       └── mixed.bib      # 混合文献
+├── pyproject.toml         # 项目配置
+└── README.md              # 本文件
+```
+
+## 常见问题
+
+**Q: 为什么有些真实的文献被标记为"可疑"？**
+
+A: 可能是因为：
+- 标题拼写与数据库中略有不同
+- 文献太新，还没被索引
+- 非CS领域的文献（DBLP只收录CS）
+
+可以尝试降低阈值：`realcite references.bib --threshold 0.6`
+
+**Q: 验证速度很慢？**
+
+A: 每条引用需要查询多个API，每个API有请求间隔限制。100条引用大约需要3-5分钟。
+
+**Q: 需要API密钥吗？**
+
+A: 基本使用不需要。但如果验证量大，建议申请Semantic Scholar的API Key以提高限额。
+
+## 运行测试
+
+```bash
+# 安装测试依赖
+pip install pytest pytest-mock
+
+# 运行测试
+pytest tests/ -v
+```
+
+## 许可证
+
+MIT License