Metadata-Version: 2.4
Name: openfic
Version: 0.4.4
Summary: Ready for adding.
Project-URL: Homepage, https://github.com/syrizelink/OpenFic
Project-URL: Repository, https://github.com/syrizelink/OpenFic
Author-email: Syrize <syrize@qq.com>
License-Expression: Apache-2.0
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Framework :: FastAPI
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Requires-Python: <3.14,>=3.12
Requires-Dist: aiocache>=0.12.3
Requires-Dist: aiofiles>=22.0
Requires-Dist: aiosqlite>=0.22.0
Requires-Dist: alembic>=1.17.2
Requires-Dist: argon2-cffi>=25.1.0
Requires-Dist: charset-normalizer>=3.4.7
Requires-Dist: cryptography>=46.0.3
Requires-Dist: fastapi>=0.127.0
Requires-Dist: fastembed>=0.8.0
Requires-Dist: gunicorn>=23.0.0
Requires-Dist: itsdangerous>=2.2.0
Requires-Dist: json-repair>=0.60.1
Requires-Dist: lancedb>=0.26.0
Requires-Dist: langchain-amazon-nova>=1.0.1
Requires-Dist: langchain-anthropic>=1.3.1
Requires-Dist: langchain-cohere>=0.5.1
Requires-Dist: langchain-deepseek>=1.0.1
Requires-Dist: langchain-google-genai>=4.1.3
Requires-Dist: langchain-groq>=1.1.2
Requires-Dist: langchain-huggingface>=1.2.2
Requires-Dist: langchain-mistralai>=1.1.1
Requires-Dist: langchain-nvidia-ai-endpoints>=1.4.0
Requires-Dist: langchain-ollama>=1.0.1
Requires-Dist: langchain-openai>=1.1.6
Requires-Dist: langchain-openrouter>=0.2.3
Requires-Dist: langchain>=1.3.0
Requires-Dist: langgraph-checkpoint-sqlite>=3.0.5
Requires-Dist: langgraph>=1.0.8
Requires-Dist: loguru>=0.7.3
Requires-Dist: mem0ai>=1.0.2
Requires-Dist: nanoid>=2.0.0
Requires-Dist: pillow<12.0,>=8.0
Requires-Dist: pydantic-settings>=2.12.0
Requires-Dist: pyjwt[crypto]>=2.10.1
Requires-Dist: python-multipart>=0.0.21
Requires-Dist: python-socketio[asgi]>=5.11.0
Requires-Dist: pyyaml>=6.0.2
Requires-Dist: pyzmq>=27.1.0
Requires-Dist: sqlalchemy>=2.0.45
Requires-Dist: sqlmodel>=0.0.27
Requires-Dist: starlette-compress>=1.6.1
Requires-Dist: tiktoken>=0.12.0
Requires-Dist: uvicorn[standard]>=0.40.0
Description-Content-Type: text/markdown

# OpenFic
<p>
  <img src="https://img.shields.io/badge/Python-3.12%2B-3776AB?style=flat-square&logo=python&logoColor=white" alt="Python 3.12+">
  <img src="https://img.shields.io/badge/react-19-149ECA?style=flat-square&logo=react&logoColor=white" alt="React 19">
  <img src="https://img.shields.io/badge/fastapi-0.127%2B-009688?style=flat-square&logo=fastapi&logoColor=white" alt="FastAPI">
</p>


**OpenFic** 是AI Agent时代专为小说创作打造的一站式写作平台，构建设定、设计角色、定制工作流，让Agent适应你的写作流程，而非反之。与OpenFic一起，将你的脑海中的世界变为现实。

## 特性

- 🚀开箱即用：使用Docker或pip快速安装，无需复杂配置
- 🤝全面的模型支持：无缝集成来自数十家提供商的模型，或是任何兼容OpenAI API的模型
- 📱响应式UI：在桌面端、移动端和浏览器上享受无缝的流畅体验
- 🧩定制化工作流：高度可配置的Agent系统，自由的修改任何Prompt，构建属于你的工作流
- ✒️以写作为中心：与Agent深度集成的辅助创作，发散思维、构建情节、协同编辑，告别抽卡式的一键生成
- 💾本地持久化：所有项目数据保存在本地，零云存储依赖
- 🧠语义化检索：基于向量的Agentic RAG，让Agent能够在百万字级别的项目中高效检索过往信息
- ⚖️成本优先的上下文管理：智能压缩、动态截断、稳定缓存，尽可能降低使用成本


## 安装

### 🐳 Docker（推荐）

如果使用容器方式安装进行自托管是推荐的安装方式。

#### 1. 拉取镜像

```bash
docker pull ghcr.io/syrizelink/openfic:latest
```

#### 2. 运行容器

```bash
docker run -d -p 8000:8000 -v "openfic:/data" --name openfic ghcr.io/syrizelink/openfic:latest
```

#### 3. 启动后访问

```text
http://localhost:8000
```

### 🐍 Python pip

在开始安装前，确保你已经安装了Python3.12+

#### 1. 安装OpenFic

```bash
pip install openfic
```

#### 2. 启动服务

```bash
openfic serve
```

#### 3. 启动后访问

```text
http://localhost:8000
```

### 桌面应用

前往 <https://github.com/syrizelink/OpenFic/releases> 下载桌面应用，在你的系统上原生运行，而无需额外步骤。