neuro-simulator 0.0.2__tar.gz → 0.1.2__tar.gz

{neuro_simulator-0.0.2 → neuro_simulator-0.1.2}/PKG-INFO

@@ -1,13 +1,14 @@
 Metadata-Version: 2.4
-Name: neuro-simulator
-Version: 0.0.2
+Name: neuro_simulator
+Version: 0.1.2
 Summary: Neuro Simulator Server
-Home-page: https://github.com/Moha-Master/neuro-simulator
-Author: Moha-Master
-Author-email: hongkongreporter@outlook.com
+Author-email: Moha-Master <hongkongreporter@outlook.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/Moha-Master/neuro-simulator
+Project-URL: Repository, https://github.com/Moha-Master/neuro-simulator
+Project-URL: Issues, https://github.com/Moha-Master/neuro-simulator/issues
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.8
@@ -28,33 +29,27 @@ Requires-Dist: pydantic
 Requires-Dist: jinja2
 Requires-Dist: python-multipart
 Requires-Dist: mutagen
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
+Provides-Extra: dev
+Requires-Dist: pytest>=6.0; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
 
 # Neuro-Simulator 服务端
 
-*关注Vedal喵，关注Vedal谢谢喵*
-
 *本临时README由AI自动生成*
 
-这是 Neuro Simulator 的后端服务，基于 Python 和 FastAPI 构建，负责处理直播逻辑、AI 交互、TTS 合成等核心功能。
+这是 Neuro Simulator 的服务端，负责处理直播逻辑、AI 交互、TTS 合成等核心功能。
 
 ## 功能特性
 
-- **多 LLM 支持**：支持 Gemini 和 OpenAI API，用于生成观众聊天内容
+- **动态观众**：调用无状态LLM，动态生成观众聊天内容，支持 Gemini 和 OpenAI API
 - **配置管理**：支持通过 API 动态修改和热重载配置
 - **外部控制**：完全使用外部API端点操控服务端运行
 
 ## 目录结构
 
-```
+``` main
 neuro_simulator/
 ├── main.py              # 应用入口和核心逻辑
 ├── config.py            # 配置管理模块
@@ -68,87 +63,73 @@ neuro_simulator/
 ├── shared_state.py      # 全局状态管理
 ├── log_handler.py       # 日志处理模块
 ├── requirements.txt     # Python 依赖列表
-├── setup.py             # Python 包安装配置
+├── pyproject.toml       # Python 包安装配置
 ├── cli.py               # 命令行启动脚本
-├── settings.yaml.example # 自带的备用配置模板
+├── config.yaml.example # 自带的备用配置模板
 └── media/               # 自带的备用媒体文件
-    └── neuro_start.mp4  # 用来计算Start Soon长度，仅读取时长
+    └── neuro_start.mp4  # 用来计算Start Soon长度，仅读取时长
 ```
 
-```
-working_dir_example/     # 工作目录结构
+``` workin'dir
+working_dir_example/     # 工作目录结构，请将这个目录重命名和复制到你想要的位置（推荐放到~/.config/neuro-simulator）
 ├── media/               # 媒体文件夹，如缺失会使用自带资源覆盖
-│   └── neuro_start.mp4  # 用来计算Start Soon长度，仅读取时长
-├── settings.yaml        # 由用户手工创建的配置文件
-└── settings.yaml.example # 自动生成的配置文件模板，必须手动重命名和填写
+│   └── neuro_start.mp4  # 用来计算Start Soon长度，仅读取时长,请和客户端的视频保持一致
+├── config.yaml        # 由用户手工创建的配置文件
+└── config.yaml.example # 自动生成的配置文件模板，必须手动重命名和填写
 ```
 
 ## 安装与配置
 
-0. **配置设置**
-   复制一份 `working_dir_example` 到你想要的位置，作为配置文件目录
-   然后进入配置文件目录，复制 `settings.yaml.example` 到 `settings.yaml`
-   编辑 `settings.yaml` 文件，填入必要的 API 密钥和配置项：
+0. **在运行server前，必须有已经配置完成的Letta Agent。**
+1. 复制一份 `../docs/working_dir_example` 到你想要的位置，作为配置文件目录.
+   - 程序会在未指定 `--dir` 的情况下自动生成一个工作目录，路径为 `~/.config/neuro-simulator/`
+2. 然后进入配置文件目录，复制 `config.yaml.example` 到 `config.yaml`
+3. 编辑 `config.yaml` 文件，填入必要的 API 密钥和配置项：
    - Letta Token 和 Agent ID
    - Gemini/OpenAI API Key
    - Azure TTS Key 和 Region
-   可以执行替换media/neuro_start.mp4为其它视频文件，但记得手动替换client中的同名文件
-
-### 方法一：使用 pip 安装
-
-1. **从云端安装PyPi包，适合直接使用**
-   ```bash
-   python3 -m venv venv
-   # Windows
-   venv/Scripts/pip install neuro-simulator
-   # macOS/Linux
-   venv/bin/pip install neuro-simulator
-   ```
-
-   **从本地安装PyPi包，适合二次开发**
-   ```bash
-   python3 -m venv venv
-   #Windows
-   venv/Scripts/pip install -e .
-   # macOS/Linux
-   venv/bin/pip install -e .
-   ```
-
-2. **运行服务**
-   ```bash
-   # 使用默认配置 (~/.config/neuro-simulator/)
-   neuro
-   
-   # 指定工作目录
-   neuro -D /path/to/your/config
-   
-   # 指定主机和端口
-   neuro -H 0.0.0.0 -P 8080
-   
-   # 组合使用
-   neuro -D /path/to/your/config -H 0.0.0.0 -P 8080
-   ```
-
-### 方法二：传统方式运行
-
-1. **创建并激活虚拟环境**
-   ```bash
-   python -m venv venv
-   # Windows
-   venv\Scripts\activate
-   # macOS/Linux
-   source venv/bin/activate
-   ```
-
-2. **安装依赖**
-   ```bash
-   pip install -r requirements.txt
-   ```
-
-3. **启动服务**
-   ```bash
-   uvicorn main:app --host 127.0.0.1 --port 8000
-   ```
+
+可以执行替换media/neuro_start.mp4为其它视频文件，但记得手动替换client中的同名文件。
+
+### 直接安装方式（无需二次开发）
+
+若无需二次开发，可以直接使用pip安装：
+```bash
+python3 -m venv venv
+# Windows
+venv/Scripts/pip install neuro-simulator
+# macOS/Linux
+venv/bin/pip install neuro-simulator
+```
+
+### 二次开发方式
+
+若需要二次开发，请克隆项目，在server下建立venv，然后pip install -e ./：
+```bash
+git clone https://github.com/your-username/Neuro-Simulator.git
+cd Neuro-Simulator/server
+python3 -m venv venv
+# Windows
+venv/Scripts/pip install -e .
+# macOS/Linux
+venv/bin/pip install -e .
+```
+
+### 运行服务
+
+```bash
+# 使用默认配置 (位于~/.config/neuro-simulator/)
+neuro
+
+# 指定工作目录
+neuro -D /path/to/your/config
+
+# 指定主机和端口
+neuro -H 0.0.0.0 -P 8080
+
+# 组合使用
+neuro -D /path/to/your/config -H 0.0.0.0 -P 8080
+```
 
 服务默认运行在 `http://127.0.0.1:8000`。
 
@@ -169,7 +150,7 @@ working_dir_example/     # 工作目录结构
 
 ## 配置说明
 
-配置文件 `settings.yaml` 包含以下主要配置项：
+配置文件 `config.yaml` 包含以下主要配置项：
 
 - `api_keys` - 各种服务的 API 密钥
 - `stream_metadata` - 直播元数据（标题、分类、标签等）
@@ -179,11 +160,13 @@ working_dir_example/     # 工作目录结构
 - `performance` - 性能相关设置
 - `server` - 服务器设置（主机、端口、CORS 等）
 
+有关配置文件的完整示例，请参阅项目根目录下的 `docs/working_dir_example/` 文件夹。
+
 ## 安全说明
 
 1. 通过 `panel_password` 配置项可以设置控制面板访问密码
 2. 敏感配置项（如 API 密钥）不会通过 API 接口暴露
-3. 支持 CORS，但仅允许预配置的来源访问
+3. 支持 CORS，仅允许预配置的来源访问
 
 ## 故障排除
 

{neuro_simulator-0.0.2 → neuro_simulator-0.1.2}/README.md

@@ -1,20 +1,18 @@
 # Neuro-Simulator 服务端
 
-*关注Vedal喵，关注Vedal谢谢喵*
-
 *本临时README由AI自动生成*
 
-这是 Neuro Simulator 的后端服务，基于 Python 和 FastAPI 构建，负责处理直播逻辑、AI 交互、TTS 合成等核心功能。
+这是 Neuro Simulator 的服务端，负责处理直播逻辑、AI 交互、TTS 合成等核心功能。
 
 ## 功能特性
 
-- **多 LLM 支持**：支持 Gemini 和 OpenAI API，用于生成观众聊天内容
+- **动态观众**：调用无状态LLM，动态生成观众聊天内容，支持 Gemini 和 OpenAI API
 - **配置管理**：支持通过 API 动态修改和热重载配置
 - **外部控制**：完全使用外部API端点操控服务端运行
 
 ## 目录结构
 
-```
+``` main
 neuro_simulator/
 ├── main.py              # 应用入口和核心逻辑
 ├── config.py            # 配置管理模块
@@ -28,87 +26,73 @@ neuro_simulator/
 ├── shared_state.py      # 全局状态管理
 ├── log_handler.py       # 日志处理模块
 ├── requirements.txt     # Python 依赖列表
-├── setup.py             # Python 包安装配置
+├── pyproject.toml       # Python 包安装配置
 ├── cli.py               # 命令行启动脚本
-├── settings.yaml.example # 自带的备用配置模板
+├── config.yaml.example # 自带的备用配置模板
 └── media/               # 自带的备用媒体文件
-    └── neuro_start.mp4  # 用来计算Start Soon长度，仅读取时长
+    └── neuro_start.mp4  # 用来计算Start Soon长度，仅读取时长
 ```
 
-```
-working_dir_example/     # 工作目录结构
+``` workin'dir
+working_dir_example/     # 工作目录结构，请将这个目录重命名和复制到你想要的位置（推荐放到~/.config/neuro-simulator）
 ├── media/               # 媒体文件夹，如缺失会使用自带资源覆盖
-│   └── neuro_start.mp4  # 用来计算Start Soon长度，仅读取时长
-├── settings.yaml        # 由用户手工创建的配置文件
-└── settings.yaml.example # 自动生成的配置文件模板，必须手动重命名和填写
+│   └── neuro_start.mp4  # 用来计算Start Soon长度，仅读取时长,请和客户端的视频保持一致
+├── config.yaml        # 由用户手工创建的配置文件
+└── config.yaml.example # 自动生成的配置文件模板，必须手动重命名和填写
 ```
 
 ## 安装与配置
 
-0. **配置设置**
-   复制一份 `working_dir_example` 到你想要的位置，作为配置文件目录
-   然后进入配置文件目录，复制 `settings.yaml.example` 到 `settings.yaml`
-   编辑 `settings.yaml` 文件，填入必要的 API 密钥和配置项：
+0. **在运行server前，必须有已经配置完成的Letta Agent。**
+1. 复制一份 `../docs/working_dir_example` 到你想要的位置，作为配置文件目录.
+   - 程序会在未指定 `--dir` 的情况下自动生成一个工作目录，路径为 `~/.config/neuro-simulator/`
+2. 然后进入配置文件目录，复制 `config.yaml.example` 到 `config.yaml`
+3. 编辑 `config.yaml` 文件，填入必要的 API 密钥和配置项：
    - Letta Token 和 Agent ID
    - Gemini/OpenAI API Key
    - Azure TTS Key 和 Region
-   可以执行替换media/neuro_start.mp4为其它视频文件，但记得手动替换client中的同名文件
-
-### 方法一：使用 pip 安装
-
-1. **从云端安装PyPi包，适合直接使用**
-   ```bash
-   python3 -m venv venv
-   # Windows
-   venv/Scripts/pip install neuro-simulator
-   # macOS/Linux
-   venv/bin/pip install neuro-simulator
-   ```
-
-   **从本地安装PyPi包，适合二次开发**
-   ```bash
-   python3 -m venv venv
-   #Windows
-   venv/Scripts/pip install -e .
-   # macOS/Linux
-   venv/bin/pip install -e .
-   ```
-
-2. **运行服务**
-   ```bash
-   # 使用默认配置 (~/.config/neuro-simulator/)
-   neuro
-   
-   # 指定工作目录
-   neuro -D /path/to/your/config
-   
-   # 指定主机和端口
-   neuro -H 0.0.0.0 -P 8080
-   
-   # 组合使用
-   neuro -D /path/to/your/config -H 0.0.0.0 -P 8080
-   ```
-
-### 方法二：传统方式运行
-
-1. **创建并激活虚拟环境**
-   ```bash
-   python -m venv venv
-   # Windows
-   venv\Scripts\activate
-   # macOS/Linux
-   source venv/bin/activate
-   ```
-
-2. **安装依赖**
-   ```bash
-   pip install -r requirements.txt
-   ```
-
-3. **启动服务**
-   ```bash
-   uvicorn main:app --host 127.0.0.1 --port 8000
-   ```
+
+可以执行替换media/neuro_start.mp4为其它视频文件，但记得手动替换client中的同名文件。
+
+### 直接安装方式（无需二次开发）
+
+若无需二次开发，可以直接使用pip安装：
+```bash
+python3 -m venv venv
+# Windows
+venv/Scripts/pip install neuro-simulator
+# macOS/Linux
+venv/bin/pip install neuro-simulator
+```
+
+### 二次开发方式
+
+若需要二次开发，请克隆项目，在server下建立venv，然后pip install -e ./：
+```bash
+git clone https://github.com/your-username/Neuro-Simulator.git
+cd Neuro-Simulator/server
+python3 -m venv venv
+# Windows
+venv/Scripts/pip install -e .
+# macOS/Linux
+venv/bin/pip install -e .
+```
+
+### 运行服务
+
+```bash
+# 使用默认配置 (位于~/.config/neuro-simulator/)
+neuro
+
+# 指定工作目录
+neuro -D /path/to/your/config
+
+# 指定主机和端口
+neuro -H 0.0.0.0 -P 8080
+
+# 组合使用
+neuro -D /path/to/your/config -H 0.0.0.0 -P 8080
+```
 
 服务默认运行在 `http://127.0.0.1:8000`。
 
@@ -129,7 +113,7 @@ working_dir_example/     # 工作目录结构
 
 ## 配置说明
 
-配置文件 `settings.yaml` 包含以下主要配置项：
+配置文件 `config.yaml` 包含以下主要配置项：
 
 - `api_keys` - 各种服务的 API 密钥
 - `stream_metadata` - 直播元数据（标题、分类、标签等）
@@ -139,11 +123,13 @@ working_dir_example/     # 工作目录结构
 - `performance` - 性能相关设置
 - `server` - 服务器设置（主机、端口、CORS 等）
 
+有关配置文件的完整示例，请参阅项目根目录下的 `docs/working_dir_example/` 文件夹。
+
 ## 安全说明
 
 1. 通过 `panel_password` 配置项可以设置控制面板访问密码
 2. 敏感配置项（如 API 密钥）不会通过 API 接口暴露
-3. 支持 CORS，但仅允许预配置的来源访问
+3. 支持 CORS，仅允许预配置的来源访问
 
 ## 故障排除
 

neuro_simulator-0.1.2/neuro_simulator/__init__.py

@@ -0,0 +1,10 @@
+# neuro_simulator/__init__.py
+
+# 导出主要模块以便于使用
+from .builtin_agent import initialize_builtin_agent, get_builtin_response, reset_builtin_agent_memory
+
+__all__ = [
+    "initialize_builtin_agent",
+    "get_builtin_response",
+    "reset_builtin_agent_memory"
+]

neuro_simulator-0.1.2/neuro_simulator/agent/__init__.py

@@ -0,0 +1,8 @@
+# agent/__init__.py
+"""
+Agent module for Neuro Simulator Server
+"""
+
+from .core import Agent
+
+__all__ = ["Agent"]