paperboy 的安装和配置教程

项目基础介绍

paperboy 是一个用于调度 Jupyter 笔记本报告的生产级应用程序。它拥有灵活的架构和可扩展的 API，能够集成到多种部署环境中。该项目使用了一系列来自开源世界的工业级技术。

主要编程语言

该项目主要使用 Python 和 TypeScript 编程语言。

关键技术和框架

• Jupyter Notebooks：用于报告本身的模板。
• Papermill：用于参数化笔记本。
• SQLAlchemy：用于存储（默认）。
• Apache Airflow：用于调度（默认）。
• Dask：用于 Airflow Workers。
• Luigi：作为 Airflow 的调度替代（依赖于 cron）。
• PhosphorJS：用于前端。

准备工作

在开始安装 paperboy 之前，请确保您的系统中已经安装了以下依赖项：

• Python
• Node.js

如果您的系统中已经安装了 conda，可以使用 conda-forge 通道来安装这些依赖项。

安装步骤

1. 克隆仓库：

   git clone https://github.com/tkp-archive/paperboy.git
   cd paperboy
   

2. 安装 Node.js 依赖项：

   npm install
   

3. 构建前端：

   npm run build
   

4. 安装 Python 依赖项：

   pip install -e .
   

5. 启动应用程序：

   python -m paperboy
   

6. 在浏览器中访问应用程序：

   打开浏览器并访问 http://0.0.0.0:8080。

7. 默认的认证后端需要注册一个用户名，该用户名可以在随后的启动中使用。

按照上述步骤操作后，您应该能够成功安装并运行 paperboy 应用程序。