AI-Paper-Collector 项目使用教程
1. 项目的目录结构及介绍
AI-Paper-Collector 项目的目录结构如下:
AI-Paper-Collector/
├── cache/
├── conf/
├── pics/
├── web-vue/
├── .gitignore
├── LICENSE
├── README.md
├── app.py
├── crawler.py
├── maintain.py
├── requirements.txt
├── update_cache.py
目录介绍
cache/
: 用于存储缓存文件。conf/
: 包含项目的配置文件。pics/
: 存储项目相关的图片文件。web-vue/
: 前端 Vue 项目的目录。.gitignore
: Git 忽略文件列表。LICENSE
: 项目的开源许可证文件。README.md
: 项目说明文档。app.py
: 项目的启动文件。crawler.py
: 用于爬取 AI 相关论文的脚本。maintain.py
: 项目维护脚本。requirements.txt
: 项目依赖的 Python 包列表。update_cache.py
: 更新缓存文件的脚本。
2. 项目的启动文件介绍
项目的启动文件是 app.py
。该文件负责启动整个项目,包括初始化配置、启动爬虫、启动前端服务等。
启动步骤
- 确保已安装所有依赖包,可以通过以下命令安装:
pip install -r requirements.txt
- 运行启动文件:
python app.py
3. 项目的配置文件介绍
项目的配置文件位于 conf/
目录下。配置文件包含了项目运行所需的各种参数,如数据库连接信息、爬虫设置、前端配置等。
配置文件示例
# conf/config.yaml
database:
host: "localhost"
port: 3306
user: "root"
password: "password"
db_name: "ai_paper_collector"
crawler:
max_threads: 10
timeout: 30
frontend:
port: 8080
配置文件说明
database
: 数据库连接信息。crawler
: 爬虫相关配置,如最大线程数和超时时间。frontend
: 前端服务配置,如端口号。
通过修改配置文件,可以灵活调整项目的运行参数,以适应不同的环境和需求。