Data Formulator项目本地开发环境搭建指南

Data Formulator项目本地开发环境搭建指南

data-formulator 🪄 Create rich visualizations with AI 项目地址: https://gitcode.com/gh_mirrors/da/data-formulator

项目概述

Data Formulator是一个由微软开发的数据处理工具，它结合了Python后端和TypeScript前端技术栈，为用户提供强大的数据操作能力。本文将详细介绍如何搭建Data Formulator的本地开发环境，帮助开发者快速上手项目开发。

环境准备

基础要求

在开始之前，请确保您的开发机器满足以下基本要求：

1. Python环境：需要Python 3.11或更高版本
2. Node.js环境：用于前端开发
3. Yarn包管理器：替代npm的JavaScript包管理工具

后端环境配置

1. 创建Python虚拟环境

虚拟环境是Python开发的推荐实践，它能隔离项目依赖，避免不同项目间的包冲突。

python -m venv venv

启动虚拟环境：

• Windows系统：

.\venv\Scripts\activate

• Unix/Linux/MacOS系统：

source venv/bin/activate

2. 安装依赖包

在虚拟环境启动状态下，安装项目所需依赖：

pip install -r requirements.txt

3. 环境变量配置

Data Formulator提供了灵活的配置选项，通过环境文件进行设置：

API密钥配置

1. 复制api-keys.env.example为api-keys.env
2. 根据您使用的服务提供商添加相应的API密钥
3. 支持的配置项包括：
   • 端点地址(endpoint)
   • 模型名称(model)
   • API密钥(api_key)
   • API基础地址(api_base)
   • API版本(api_version)

服务器配置

1. 复制.env.template为.env
2. 重要配置项说明：
   • DISABLE_DISPLAY_KEYS：设置为true可隐藏前端显示的API密钥
   • EXEC_PYTHON_IN_SUBPROCESS：设置为true可使Python代码在子进程中运行（更安全但性能略低）
   • LOCAL_DB_DIR：本地数据库存储目录
   • 外部数据库配置（当USE_EXTERNAL_DB=true时生效）：
     • 支持MySQL和PostgreSQL
     • 需要配置主机地址、端口、数据库名称、用户名和密码

4. 运行后端服务

根据您的操作系统选择相应的启动脚本：

• Windows：

.\local_server.bat

• Unix/Linux/MacOS：

./local_server.sh

前端环境配置

1. 安装依赖

使用Yarn安装前端依赖包：

yarn

2. 开发模式运行

启动前端开发服务器：

yarn start

开发服务器启动后，您可以通过浏览器访问http://localhost:5173查看应用。在开发模式下，任何代码修改都会自动触发页面刷新，方便实时查看更改效果。

生产环境构建

1. 前端构建

执行生产环境构建：

yarn build

构建结果将输出到py-src/data_formulator/dist目录。

2. Python包构建

首先安装构建工具：

pip install build

然后构建Python包：

python -m build

构建完成后，会在dist/目录下生成一个wheel文件，文件名格式为data_formulator-<version>-py3-none-any.whl。

3. 测试构建结果

建议在虚拟环境中测试构建的wheel文件：

pip install dist/data_formulator-<version>-py3-none-any.whl

安装完成后，可以通过以下命令启动应用：

data_formulator

或者：

python -m data_formulator

应用启动后，通过浏览器访问http://localhost:5000即可使用。

开发建议

1. 虚拟环境管理：始终在虚拟环境中开发和测试，避免污染系统Python环境
2. 环境变量安全：不要将包含敏感信息的.env文件提交到版本控制系统
3. 开发流程：前端开发时使用yarn start获得实时反馈，后端修改后需要重启服务
4. 生产测试：在部署前务必测试生产构建版本，确保所有功能正常工作

通过以上步骤，您已经成功搭建了Data Formulator的完整开发环境，可以开始进行功能开发和定制了。

data-formulator 🪄 Create rich visualizations with AI 项目地址: https://gitcode.com/gh_mirrors/da/data-formulator