Paperboy 项目启动与配置教程

1. 项目目录结构及介绍

Paperboy 是一个用于调度 Jupyter 笔记本报告的 Web 前端应用。项目目录结构如下：

• docs/: 存放项目文档。
• examples/: 包含示例配置和代码。
• paperboy/: 核心应用代码目录。
• scripts/: 包含项目构建和部署的脚本。
• src/: 前端代码目录。
• tests/: 单元测试和集成测试代码。
• .github/: GitHub Actions 工作流文件。
• .gitattributes: 定义 Git 仓库的属性。
• .gitignore: 定义 Git 忽略的文件。
• CODE_OF_CONDUCT.md: 项目行为准则。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目许可证信息。
• MANIFEST.in: 打包项目时包含的文件列表。
• Makefile: 构建和部署项目的 Makefile 文件。
• Paperboy_Gameplan.md: 项目计划和概述。
• Procfile: 用于部署到平台如 Heroku 的进程文件。
• README.md: 项目说明文件。
• jest.config.js: Jest 测试配置文件。
• package.json: Node.js 项目配置文件。
• paperboy.db: 数据库文件。
• pyproject.toml: Python 项目配置文件。
• setup.cfg: Python 打包配置文件。
• setup.py: Python 设置文件。
• tsconfig.json: TypeScript 配置文件。
• tslint.json: TypeScript 语法检查配置文件。
• webpack.config.js: Webpack 配置文件。

2. 项目的启动文件介绍

项目的主要启动文件是 python -m paperboy。运行该命令将启动 Paperboy 服务，默认监听 8080 端口。

在启动服务之前，需要确保已经安装了所有依赖项。可以通过以下命令安装：

npm install        # 安装 Node.js 依赖
npm run build      # 构建前端资源
pip install -e .   # 安装 Python 依赖

启动服务后，可以在浏览器中访问 http://0.0.0.0:8080 来查看应用。

3. 项目的配置文件介绍

项目的配置主要通过以下几个文件进行：

• config.py: Python 配置文件，用于定义应用级配置，如数据库连接、密钥等。
• pyproject.toml: 定义项目信息和依赖。
• tsconfig.json: TypeScript 配置文件，用于前端代码的编译和类型检查。
• webpack.config.js: Webpack 配置文件，用于前端资源的打包和优化。

具体的配置项需要根据实际部署环境和项目需求进行调整。在 config.py 中，可以设置数据库连接字符串、调度器配置等。例如：

# config.py 示例配置
SQLALCHEMY_DATABASE_URI = 'sqlite:///paperboy.db'
SCHEDULER = 'papermill'

确保在实际部署前，根据项目需求和部署环境调整所有配置项。