neuro-simulator 0.0.2__py3-none-any.whl → 0.0.3__py3-none-any.whl

neuro_simulator/cli.py

@@ -8,7 +8,7 @@ from pathlib import Path
 
 def main():
     parser = argparse.ArgumentParser(description="Neuro-Simulator Server")
-    parser.add_argument("-D", "--dir", help="Working directory containing settings.yaml")
+    parser.add_argument("-D", "--dir", help="Working directory containing config.yaml")
     parser.add_argument("-H", "--host", help="Host to bind the server to")
     parser.add_argument("-P", "--port", type=int, help="Port to bind the server to")
     
@@ -28,38 +28,38 @@ def main():
     # Change to working directory
     os.chdir(work_dir)
     
-    # Handle settings.yaml.example
-    settings_example_path = work_dir / "settings.yaml.example"
-    settings_path = work_dir / "settings.yaml"
+    # Handle config.yaml.example
+    settings_example_path = work_dir / "config.yaml.example"
+    settings_path = work_dir / "config.yaml"
     
-    # Copy settings.yaml.example from package if it doesn't exist
+    # Copy config.yaml.example from package if it doesn't exist
     if not settings_example_path.exists():
         try:
             # Try pkg_resources first (for installed packages)
             try:
                 import pkg_resources
-                example_path = pkg_resources.resource_filename('neuro_simulator', 'settings.yaml.example')
+                example_path = pkg_resources.resource_filename('neuro_simulator', 'config.yaml.example')
                 if os.path.exists(example_path):
                     shutil.copy(example_path, settings_example_path)
                     print(f"Created {settings_example_path} from package example")
                 else:
                     # Fallback to relative path (for development mode)
-                    dev_example_path = Path(__file__).parent / "settings.yaml.example"
+                    dev_example_path = Path(__file__).parent / "config.yaml.example"
                     if dev_example_path.exists():
                         shutil.copy(dev_example_path, settings_example_path)
                         print(f"Created {settings_example_path} from development example")
                     else:
-                        print("Warning: settings.yaml.example not found in package or development folder")
+                        print("Warning: config.yaml.example not found in package or development folder")
             except Exception:
                 # Fallback to relative path (for development mode)
-                dev_example_path = Path(__file__).parent / "settings.yaml.example"
+                dev_example_path = Path(__file__).parent / "config.yaml.example"
                 if dev_example_path.exists():
                     shutil.copy(dev_example_path, settings_example_path)
                     print(f"Created {settings_example_path} from development example")
                 else:
-                    print("Warning: settings.yaml.example not found in package or development folder")
+                    print("Warning: config.yaml.example not found in package or development folder")
         except Exception as e:
-            print(f"Warning: Could not copy settings.yaml.example from package: {e}")
+            print(f"Warning: Could not copy config.yaml.example from package: {e}")
     
     # Handle media folder
     media_dir = work_dir / "media"
@@ -101,7 +101,7 @@ def main():
     # Now check for required files and handle errors appropriately
     errors = []
     
-    # Check for settings.yaml (required for running)
+    # Check for config.yaml (required for running)
     if not settings_path.exists():
         if settings_example_path.exists():
             errors.append(f"Error: {settings_path} not found. Please copy {settings_example_path} to {settings_path} and configure it.")

neuro_simulator/config.py

@@ -88,7 +88,7 @@ class AppSettings(BaseModel):
 
 # --- 2. 加载和管理配置的逻辑 ---
 
-CONFIG_FILE_PATH = "settings.yaml"
+CONFIG_FILE_PATH = "config.yaml"
 
 def _deep_update(source: dict, overrides: dict) -> dict:
     """
@@ -120,7 +120,7 @@ class ConfigManager:
 
     def _load_config_from_yaml(self) -> dict:
         if not os.path.exists(CONFIG_FILE_PATH):
-            logging.warning(f"{CONFIG_FILE_PATH} not found. Using default settings. You can create it from settings.yaml.example.")
+            logging.warning(f"{CONFIG_FILE_PATH} not found. Using default settings. You can create it from config.yaml.example.")
             return {}
         try:
             with open(CONFIG_FILE_PATH, 'r', encoding='utf-8') as f:
@@ -141,14 +141,14 @@ class ConfigManager:
             missing_keys.append("api_keys.neuro_agent_id")
             
         if missing_keys:
-            raise ValueError(f"Critical config missing in settings.yaml: {', '.join(missing_keys)}. "
-                           f"Please check your settings.yaml file against settings.yaml.example.")
+            raise ValueError(f"Critical config missing in config.yaml: {', '.join(missing_keys)}. "
+                           f"Please check your config.yaml file against config.yaml.example.")
 
         logging.info("Configuration loaded successfully.")
         return base_settings
 
     def save_settings(self):
-        """Saves the current configuration to settings.yaml."""
+        """Saves the current configuration to config.yaml."""
         try:
             # 1. Get the current settings from memory
             config_to_save = self.settings.model_dump(mode='json', exclude={'api_keys'})

{neuro_simulator-0.0.2.dist-info → neuro_simulator-0.0.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.1
 Name: neuro-simulator
-Version: 0.0.2
+Version: 0.0.3
 Summary: Neuro Simulator Server
 Home-page: https://github.com/Moha-Master/neuro-simulator
 Author: Moha-Master
@@ -17,44 +17,33 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
+Requires-Dist: azure-cognitiveservices-speech
 Requires-Dist: fastapi
-Requires-Dist: uvicorn
 Requires-Dist: google-genai
-Requires-Dist: azure-cognitiveservices-speech
+Requires-Dist: jinja2
 Requires-Dist: letta-client
+Requires-Dist: mutagen
 Requires-Dist: openai
-Requires-Dist: pyyaml
 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
+Requires-Dist: pyyaml
+Requires-Dist: uvicorn
 
 # 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            # 配置管理模块
@@ -70,85 +59,70 @@ neuro_simulator/
 ├── requirements.txt     # Python 依赖列表
 ├── setup.py             # 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` 到你想要的位置，作为配置文件目录
+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 +143,7 @@ working_dir_example/     # 工作目录结构
 
 ## 配置说明
 
-配置文件 `settings.yaml` 包含以下主要配置项：
+配置文件 `config.yaml` 包含以下主要配置项：
 
 - `api_keys` - 各种服务的 API 密钥
 - `stream_metadata` - 直播元数据（标题、分类、标签等）
@@ -179,11 +153,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.dist-info → neuro_simulator-0.0.3.dist-info}/RECORD

@@ -1,20 +1,20 @@
 neuro_simulator/__init__.py,sha256=JJWUFh_lBowSfGMhmC9zixE70cB7GG1pTbjGY4Kg3mU,29
 neuro_simulator/audio_synthesis.py,sha256=fwS0car42-aheCFVQDgRpUTnqLv4DU9Re66PCa6zTBM,2938
 neuro_simulator/chatbot.py,sha256=qQamPO5QTPwV1avNXrzjZpiJlWN3X_6vxSZPSA17jb0,5152
-neuro_simulator/cli.py,sha256=uMN9N6n69ceBRwACQ67-reDTB4mEY7RTgBD2choO_BU,6002
-neuro_simulator/config.py,sha256=rnosgBCJ2waKB7F63paT0aRnWsda_bvmyHdzOTvIW_0,9625
+neuro_simulator/cli.py,sha256=gf_9Ar_uIodL8O2ZhrXhtXXFJzaQ6QCEzWoQub-JOeI,5978
+neuro_simulator/config.py,sha256=7ek1hKi4mxTRv1IdrkkFgY8Hb_JaPL8a637z71TKHpw,9613
+neuro_simulator/config.yaml.example,sha256=uywVEnoFZGZ4g6qdp616Qoi78F2AF21rSG99gtFiY-s,6003
 neuro_simulator/letta.py,sha256=F0PbnL9vmcznxwkTQKiK9PoGsp42FbCpSbiDuFdjUWo,6475
 neuro_simulator/log_handler.py,sha256=JlCtJ7wJ0pruVGVO5u-kz-F5uaYhlBl4H5xoGUFhT18,1079
 neuro_simulator/main.py,sha256=NlYM9OSv9sxmDIP7KEPOFyDRsU8VlQ2ngqNoNMo9CAE,22043
 neuro_simulator/process_manager.py,sha256=KqW11PRJR5e4RSBytaZdkgbd3wxRtWqlz6D0TA4oR1s,2492
-neuro_simulator/settings.yaml.example,sha256=uywVEnoFZGZ4g6qdp616Qoi78F2AF21rSG99gtFiY-s,6003
 neuro_simulator/shared_state.py,sha256=cvYg8vGrkuDmb0e-4J1xvIjXVwspRisuxQaIR9YgsyQ,459
 neuro_simulator/stream_chat.py,sha256=X655rrOW8oQ77qAFK-dQDhHT3bYiE9w44a9Na_ikM2w,997
 neuro_simulator/stream_manager.py,sha256=vA88HQGgYguFb3_GUDSY-FpTG0rsjt8J-JFtMoCWWCo,6720
 neuro_simulator/websocket_manager.py,sha256=a9mMAN7xmgK2w9tVDOOzy4DuWSwdAPatSp6bW9fhE3I,2183
 neuro_simulator/media/neuro_start.mp4,sha256=xCLnNzv4THnzRYwkdV6EiqXc-XtFd867R2ZVLDvNp0Y,8226418
-neuro_simulator-0.0.2.dist-info/METADATA,sha256=jO9a2MAGwDl9K1wYNxvRxuEKQKz3zq61NbV3QAXxaps,6152
-neuro_simulator-0.0.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-neuro_simulator-0.0.2.dist-info/entry_points.txt,sha256=qVd5ypnRRgU8Cw7rWfZ7o0OXyS9P9hgY-cRoN_mgz9g,51
-neuro_simulator-0.0.2.dist-info/top_level.txt,sha256=V8awSKpcrFnjJDiJxSfy7jtOrnuE2BgAR9hLmfMDWK8,16
-neuro_simulator-0.0.2.dist-info/RECORD,,
+neuro_simulator-0.0.3.dist-info/METADATA,sha256=aB8eWL6ZQKWQyS4b7xqMHh8Pyg3yOn0FvjM7Mzpe-F8,5940
+neuro_simulator-0.0.3.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+neuro_simulator-0.0.3.dist-info/entry_points.txt,sha256=qVd5ypnRRgU8Cw7rWfZ7o0OXyS9P9hgY-cRoN_mgz9g,51
+neuro_simulator-0.0.3.dist-info/top_level.txt,sha256=V8awSKpcrFnjJDiJxSfy7jtOrnuE2BgAR9hLmfMDWK8,16
+neuro_simulator-0.0.3.dist-info/RECORD,,

{neuro_simulator-0.0.2.dist-info → neuro_simulator-0.0.3.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.9.0)
+Generator: bdist_wheel (0.42.0)
 Root-Is-Purelib: true
 Tag: py3-none-any