什么是 Writer Framework？

Writer Framework 是一个用于构建 AI 应用程序的开源框架。您可以使用可视化编辑器构建用户界面，并以 Python 编写后端代码。

Writer Framework 速度快、灵活性高，语法简洁且易于测试。它实现了 UI 与业务逻辑的分离，从而支持构建更复杂的应用程序。

快速入门

安装

Writer Framework 支持 Linux、Mac 和 Windows 操作系统，并兼容 Python 3.9.2 到 3.12 版本。

pip install writer

创建并运行您的第一个应用

# 创建一个示例应用
writer hello

# 创建一个新的应用
writer create my_app

# 编辑您的应用（会打开可视化编辑器）
writer edit my_app

# 运行您的应用
writer run my_app

writer edit 命令会在您的浏览器中打开可视化编辑器，您可以通过拖放组件来构建用户界面。

文档

如需全面的指南、教程和 API 参考，请访问官方文档。

贡献

请参阅 CONTRIBUTING.md

关于 Writer

Writer 是面向企业的全栈生成式 AI 平台。借助与我们的 LLM 平台、基于图的 RAG 工具、AI 安全护栏等完全集成的开发者工具套件，您可以快速轻松地构建和部署生成式 AI 应用程序。更多信息请访问 writer.com。

许可证

本项目采用 Apache 2.0 许可证授权。

Writer Framework 快速上手指南

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：支持 Linux、macOS 或 Windows。
• Python 版本：需安装 Python 3.9.2 至 3.12 之间的版本。
• 前置依赖：建议确保 pip 为最新版本，以便顺利安装包。

安装步骤

使用 pip 即可快速安装 Writer Framework。国内开发者若遇到下载速度慢的问题，推荐使用清华或阿里镜像源加速安装：

# 标准安装
pip install writer

# 或使用国内镜像源加速（推荐）
pip install writer -i https://pypi.tuna.tsinghua.edu.cn/simple

基本使用

安装完成后，您可以通过命令行工具快速创建、编辑和运行应用。

1. 创建项目

您可以创建一个示例演示应用，或初始化一个新的空白项目：

# 创建并运行一个 Hello World 演示应用
writer hello

# 或者创建一个名为 my_app 的新项目
writer create my_app

2. 可视化编辑

Writer Framework 的核心优势在于其可视化编辑器。运行以下命令将在浏览器中打开编辑器，您可以通过拖拽组件来构建用户界面（UI）：

writer edit my_app

3. 运行应用

完成界面设计和后端逻辑编写后，使用以下命令启动应用：

writer run my_app

应用启动后，即可在本地浏览器中访问您的 AI 应用程序。后端业务逻辑可直接在项目的 Python 文件中进行编写和测试。