# funlesson-api

**Repository Path**: farfarfun/funlesson-api

## Basic Information

- **Project Name**: funlesson-api
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-09-16
- **Last Updated**: 2026-10-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# funlesson-api

Funlesson 后端服务，面向教师备课场景：把课程视频链接转成结构化的大纲、思维导图、PPT 和架构图。
核心处理逻辑在 [funlesson](https://github.com/farfarfun/funlesson)，这里只是 FastAPI 封装。

配套 Web 界面见 [funlesson-web](https://github.com/farfarfun/funlesson-web)。

## 功能特性

- 提交课程视频链接，异步处理并可轮询进度
- 产出：转写文字稿、结构化大纲、思维导图（markmap 文本）、PPT（可下载）、架构图（Mermaid 文本）

## 快速开始

### 环境要求

同 [funlesson 的环境要求](https://github.com/farfarfun/funlesson#环境要求)：
系统需要 `ffmpeg`，本机需要已登录的 Claude Code CLI（`claude` 命令）。

### 安装

开发检出使用：

```bash
scripts/setup.sh install-dev
```

生产安装公开 PyPI 包（可选指定版本）：

```bash
scripts/setup.sh install-prod [version]
```

### 运行

生产/常规用法，`funlesson-api` 自带服务生命周期命令：

```bash
funlesson-api server start --host 0.0.0.0 --port 18812
funlesson-api server status
funlesson-api server stop
funlesson-api server restart
```

升级、回退或卸载已安装包：

```bash
funlesson-api upgrade [version]
funlesson-api rollback <version>
funlesson-api uninstall
```

调试用前台模式（`--reload` 开发时自动重载）：

```bash
funlesson-api server run --reload --port 18812
```

`server` 各命令默认监听 `127.0.0.1:18812`，`--host`/`--port`/`--config` 可覆盖；
`--config` 缺省时读 `${XDG_CONFIG_HOME:-~/.config}/farfarfun/funlesson-api/config.toml`。
`start` 写的 PID 文件（`server.pid`）和日志（`server.log`）都放在同一个配置目录下。

任务产物默认落盘到 `./data`，可通过环境变量 `FUNLESSON_DATA_DIR` 修改。

### 从源码开发

运行服务始终通过已安装的 `funlesson-api` CLI；源码开发使用 `scripts/setup.sh install-dev` 安装依赖。

## API 文档

见 [`doc/API.md`](doc/API.md)。

## 开发指南

```bash
pytest
```

测试通过 monkeypatch 替换 `funlesson.pipeline.process`，不依赖真实下载/转写/claude 调用。

## 变更日志

见 [`CHANGELOG.md`](CHANGELOG.md)。

---

## 关于 farfarfun

[farfarfun](https://github.com/farfarfun) 是一个专注于实用工具库的开源组织，
涵盖云存储、数据处理、AI、多媒体与开发工具链等方向。

- 🏠 组织主页：<https://github.com/farfarfun>
- 📦 PyPI：<https://pypi.org/user/niuliangtao/>
- 📧 联系：farfarfun@qq.com

本项目基于 [MIT](LICENSE) 协议开源。