Paper-Scraper 项目使用教程

1. 项目目录结构及介绍

Paper-Scraper 是一个用于从期刊抓取论文的开源项目。以下是项目的目录结构及其简单介绍：

paper-scraper/
├── .github/              # GitHub 工作流配置目录
│   └── workflows/        # 包含 CI/CD 工作流文件
├── tests/                # 测试代码目录
├── .gitignore            # Git 忽略文件配置
├── .pre-commit-config.yaml # pre-commit 配置文件
├── LICENSE              # 项目许可证文件
├── README.md            # 项目说明文件
├── dev-requirements.txt # 开发环境依赖文件
├── pyproject.toml        # Python 项目配置文件

• .github/: 存放与 GitHub 相关的配置文件，例如工作流（CI/CD）配置。
• tests/: 包含项目的单元测试代码。
• .gitignore: 指定 Git 应该忽略的文件和目录。
• .pre-commit-config.yaml: 配置 pre-commit 钩子，用于自动化代码风格检查和修复。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的基本介绍和使用说明。
• dev-requirements.txt: 项目开发环境所需的依赖列表。
• pyproject.toml: Python 项目配置文件，用于定义项目信息和依赖。

2. 项目的启动文件介绍

在 Paper-Scraper 项目中，并没有一个明确的启动文件，因为这是一个库项目，通常作为其他应用的一部分被导入使用。然而，为了运行测试或者示例代码，你可以使用 Python 直接执行 tests/ 目录中的测试文件或 README.md 中提供的示例代码。

例如，以下是一个使用 Paper-Scraper 的基本示例：

import paperscraper
papers = paperscraper.search_papers('bayesian model selection', limit=10, pdir='downloaded-papers')

这段代码会搜索关键词为 "bayesian model selection" 的论文，并下载最多 10 篇到指定的目录。

3. 项目的配置文件介绍

项目的配置主要包含在 pyproject.toml 和 .pre-commit-config.yaml 文件中。

• pyproject.toml: 这个文件定义了项目的基本信息和依赖。例如，它可能包含如下内容：

[tool.poetry]
name = "paper-scraper"
version = "0.1.0"
description = "A proof of concept to scrape papers from journals"
authors = ["Your Name <[e-mail]>"]

[tool.poetry.dependencies]
python = "^3.8"

[tool.poetry.dev-dependencies]
pytest = "^6.2"

• .pre-commit-config.yaml: 这个文件用于配置 pre-commit 钩子，它会自动在每次提交前运行一些任务，如代码风格检查和格式化。例如：

-   repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v2.0.0
    hooks:
      -   id: black
      -   id: isort

以上配置会在每次提交前运行 Black 和 isort，确保代码风格的一致性。