Skip to content

ADANIE/novel_flow

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

novel agent

一个基于 AI 的网文创作工具,支持小说创大纲管理、章节生成功能。最终目标是尽可能将作者从繁杂的工作中解放出来,专注于创意实现。

功能特性

  • 小说创作:基于创意生成完整小说,支持自定义章节数和字数
  • 大纲管理:生成、修改、版本控制小说大纲
  • 章节管理:生成、修改、排序、合并、拆分章节
  • 风格管理(实现中):创建、修改、删除、复制写作风格
  • 人物关系管理(实现中):添加、更新、删除人物及关系
  • 世界设定管理(实现中):构建和管理小说世界观
  • 质量评估:评估大纲和章节质量
  • 成本管理:跟踪生成内容的成本
  • 多模型支持:兼容 OpenAI 和 Anthropic 格式的 API

技术栈

  • Python: 3.11
  • 依赖管理: Poetry
  • CLI 框架: Click, Questionary
  • 数据验证: Pydantic
  • LLM 集成: OpenAI SDK, Anthropic SDK
  • 代码质量: Ruff, Black, MyPy
  • 测试: Pytest

安装

环境要求

  • Python 3.11
  • Poetry

步骤

克隆项目:

git clone <repository-url>
cd novel_flow

使用 Poetry 安装依赖:

poetry install

配置环境变量(见下文)

复制 .env.example.env 并配置相关参数:

cp .env.example .env

配置项说明

配置项 说明 默认值
API_TYPE API 类型,可选 openaianthropic openai
OPENAI_API_KEY OpenAI API Key -
OPENAI_BASE_URL OpenAI API 基础 URL https://api.openai.com/v1
OPENAI_MODEL OpenAI 模型名称 gpt-4o
ANTHROPIC_API_KEY Anthropic API Key -
ANTHROPIC_MODEL Anthropic 模型名称 claude-3-opus-20240229
TEMPERATURE 生成温度,范围 0-1 0.7
MAX_TOKENS 最大 token 数 10000
TEST_MODE 测试模式 False

使用指南

命令行模式

创建新小说

poetry run novel-agent create

或带参数:

poetry run novel-agent create --idea "一个穿越到修真世界的程序员" --title "代码修仙" --chapters 10

管理现有小说

poetry run novel-agent novel manage

风格管理

poetry run novel-agent style

交互式模式

推荐使用交互式菜单模式,操作更直观:

poetry run novel-agent interactive

项目结构

novel_flow/
├── novel_agent/
│   ├── agent/              # LLM 代理层
│   ├── api/                # API 层
│   │   └── cli/            # 命令行接口
│   ├── config/             # 配置
│   ├── db/                 # 数据存储
│   ├── models/             # 数据模型
│   │   ├── novel.py
│   │   └── enhanced.py
│   └── services/           # 业务逻辑层
├── tests/                  # 测试
├── output/                 # 生成的小说内容
├── .env.example
├── pyproject.toml
└── README.md

开发

运行测试

poetry run pytest

代码格式化

poetry run black novel_agent/
poetry run ruff check novel_agent/ --fix

类型检查

poetry run mypy novel_agent/

许可证

本项目采用 GNU General Public License v3.0 许可证。

详见 LICENSE 文件。

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages