Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions AUTO_INSTALLATION_README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# FinGenius 自动安装说明

本项目包含一个自动安装脚本,可以简化 FinGenius 项目的安装过程。

## 使用方法

1. 确保您的系统满足以下要求:
- Python 3.12 或更高版本
- curl 或 wget(用于下载 uv 包管理器)
- Git(用于克隆仓库)

2. 运行自动安装脚本:
```bash
./install_fingenius.sh
```

3. 脚本将自动执行以下步骤:
- 检查 Python 版本
- 安装 uv 包管理器
- 克隆 FinGenius 仓库
- 创建虚拟环境
- 安装项目依赖
- 创建配置文件

4. 安装完成后,按照脚本输出的指示进行操作:
- 编辑 `config/config.toml` 文件,添加您的 API 密钥和自定义设置
- 激活虚拟环境:`source .venv/bin/activate`
- 运行应用程序:`python main.py STOCK_CODE`

## 手动安装

如果您更喜欢手动安装,或者自动安装脚本出现问题,请参考 `INSTALLATION_GUIDE.md` 文件中的详细说明。

## 故障排除

如果在运行自动安装脚本时遇到问题,请检查以下几点:

1. 确保您的系统满足所有要求
2. 检查是否有足够的磁盘空间
3. 确保网络连接稳定
4. 查看脚本输出的错误信息

如果问题仍然存在,请在项目的 GitHub 仓库中提交 issue。
34 changes: 34 additions & 0 deletions AUTO_INSTALLATION_SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# FinGenius 自动安装项目总结

本项目为 FinGenius 创建了完整的自动安装解决方案,包括以下文件:

## 安装脚本

1. **install_fingenius.sh** - Unix/macOS 系统的自动安装脚本
2. **install_fingenius.bat** - Windows 系统的自动安装脚本

## 配置和文档

1. **INSTALLATION_GUIDE.md** - 详细的安装指南
2. **AUTO_INSTALLATION_README.md** - 自动安装说明
3. **INSTALLATION_SUMMARY.md** - 安装方法汇总

## 便利工具

1. **test_installation.py** - 安装验证脚本
2. **run_fingenius.py** - 便捷运行脚本
3. **Makefile** - Make 命令行工具支持

## 更新的文件

1. **README.md** - 更新了安装说明,添加了自动安装选项

## 使用方法

用户可以选择以下任一方式安装 FinGenius:

1. **手动安装** - 按照 README.md 中的说明逐步安装
2. **自动安装** - 使用提供的脚本自动完成安装过程
3. **Make 安装** - 使用 Makefile 简化安装过程

所有安装方法都会创建必要的配置文件,并提供验证步骤以确保安装成功。
65 changes: 65 additions & 0 deletions EASY_INSTALL_README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# FinGenius 一键安装指南

本项目提供了一键安装脚本,可以自动检测您的操作系统并执行相应的安装流程,简化 FinGenius 项目的安装过程。

## 系统要求

- Python 3.12 或更高版本
- 稳定的网络连接
- 足够的磁盘空间

## 一键安装方法

### Windows 系统

1. 双击运行 `install.bat` 文件
2. 按照屏幕提示完成安装

### macOS 或 Linux 系统

1. 打开终端
2. 进入项目目录
3. 执行以下命令:
```bash
chmod +x install.sh
./install.sh
```
4. 按照屏幕提示完成安装

## 安装过程

自动安装脚本将执行以下步骤:

1. 检查 Python 版本
2. 安装 uv 包管理器
3. 创建虚拟环境
4. 安装项目依赖
5. 创建配置文件
6. 验证安装

## 安装后配置

安装完成后,您需要:

1. 编辑 `config/config.toml` 文件,添加您的 API 密钥和自定义设置
2. 激活虚拟环境:
- Windows: `.venv\Scripts\activate.bat`
- macOS/Linux: `source .venv/bin/activate`
3. 运行应用程序:`python main.py STOCK_CODE`

例如:`python main.py 000001`

## 故障排除

如果在安装过程中遇到问题,请检查:

1. Python 版本是否为 3.12 或更高
2. 网络连接是否稳定
3. 是否有足够的磁盘空间
4. 是否有足够的权限创建文件和目录

如果问题仍然存在,请参考 `INSTALLATION_GUIDE.md` 文件中的详细说明,或在项目的 GitHub 仓库中提交 issue。

## 手动安装

如果您更喜欢手动安装,或者自动安装脚本出现问题,请参考 `INSTALLATION_GUIDE.md` 文件中的详细说明。
72 changes: 72 additions & 0 deletions EASY_INSTALL_SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# FinGenius 一键安装实现总结

## 实现概述

为了简化 FinGenius 项目的安装过程,我们创建了一套一键安装系统,包含以下组件:

1. **auto_install.py** - 核心安装脚本,自动检测操作系统并执行相应的安装流程
2. **install.sh** - Unix/Linux/macOS 系统的启动脚本
3. **install.bat** - Windows 系统的启动脚本
4. **EASY_INSTALL_README.md** - 一键安装使用说明

## 技术实现

### 跨平台兼容性

安装系统设计为跨平台兼容,支持:
- Windows
- macOS
- Linux

通过 Python 的 `platform` 模块检测操作系统类型,并执行相应的安装命令。

### 自动化流程

安装过程完全自动化,包括:

1. **环境检测**
- Python 版本检查
- 必要工具检查(curl/wget)

2. **依赖管理**
- 自动安装 uv 包管理器
- 创建虚拟环境
- 安装项目依赖

3. **配置设置**
- 自动创建配置文件
- 提供配置指导

4. **安装验证**
- 验证关键文件存在
- 测试模块导入

### 用户体验优化

- **彩色输出**:使用 ANSI 颜色代码增强可读性
- **详细提示**:每个步骤都有清晰的提示和状态反馈
- **错误处理**:完善的错误处理和故障排除指导
- **后续指导**:安装完成后提供明确的后续步骤

## 使用方法

用户只需根据其操作系统执行相应的启动脚本:

- Windows: 双击 `install.bat`
- macOS/Linux: 执行 `./install.sh`

## 优势

相比原有的安装方法,一键安装系统具有以下优势:

1. **简化操作**:减少用户需要手动执行的命令
2. **统一体验**:在不同操作系统上提供一致的安装体验
3. **增强可靠性**:全面的错误检测和处理
4. **降低门槛**:降低非技术用户的使用门槛

## 后续改进方向

1. 添加图形用户界面(GUI)安装选项
2. 实现更完善的依赖冲突解决机制
3. 添加自动更新功能
4. 增加安装日志记录功能
96 changes: 96 additions & 0 deletions ENHANCED_INSTALL_README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
# FinGenius 增强版一键安装指南

本项目提供了增强版一键安装脚本,不仅可以自动检测您的操作系统并执行相应的安装流程,还提供了进度显示、更好的错误处理和安装测试功能。

## 系统要求

- Python 3.12 或更高版本
- 稳定的网络连接
- 足够的磁盘空间

## 增强版一键安装方法

### Windows 系统

1. 双击运行 `install_enhanced.bat` 文件
2. 按照屏幕提示完成安装

### macOS 或 Linux 系统

1. 打开终端
2. 进入项目目录
3. 执行以下命令:
```bash
chmod +x install_enhanced.sh
./install_enhanced.sh
```
4. 按照屏幕提示完成安装

## 命令行参数

增强版安装脚本支持以下命令行参数:

- `--no-progress`: 禁用进度条显示
- `--skip-tests`: 跳过安装测试

示例:
```bash
# 禁用进度条
./install_enhanced.sh --no-progress

# 跳过安装测试
./install_enhanced.sh --skip-tests

# 同时使用两个参数
./install_enhanced.sh --no-progress --skip-tests
```

## 安装过程

增强版自动安装脚本将执行以下步骤:

1. 检查 Python 版本
2. 安装 uv 包管理器
3. 创建虚拟环境
4. 安装项目依赖(带进度显示)
5. 创建配置文件
6. 创建 MCP 配置文件(如果存在)
7. 验证安装
8. 运行安装测试

## 安装后配置

安装完成后,您需要:

1. 编辑 `config/config.toml` 文件,添加您的 API 密钥和自定义设置
2. 激活虚拟环境:
- Windows: `.venv\Scripts\activate.bat`
- macOS/Linux: `source .venv/bin/activate`
3. 运行应用程序:`python main.py STOCK_CODE`

例如:`python main.py 000001`

## 增强功能

相比基础版安装脚本,增强版提供了以下额外功能:

1. **进度显示**:安装依赖时显示进度条
2. **彩色输出**:使用彩色文本增强可读性
3. **命令行参数**:支持自定义安装选项
4. **安装测试**:自动验证安装是否成功
5. **MCP 配置**:自动创建 MCP 配置文件(如果存在)

## 故障排除

如果在安装过程中遇到问题,请检查:

1. Python 版本是否为 3.12 或更高
2. 网络连接是否稳定
3. 是否有足够的磁盘空间
4. 是否有足够的权限创建文件和目录

如果问题仍然存在,请参考 `INSTALLATION_GUIDE.md` 文件中的详细说明,或在项目的 GitHub 仓库中提交 issue。

## 手动安装

如果您更喜欢手动安装,或者自动安装脚本出现问题,请参考 `INSTALLATION_GUIDE.md` 文件中的详细说明。
Loading