02-安装指南.md 5.6 KB

02-安装指南 - AI驱动软件著作权申请材料生成系统

📚 学习路径第2步 | 🔧 目标:完成系统环境配置和安装验证

🗺️ 完整学习路径:00-文档导航 → 01-快速开始 → 02-安装指南 → 03-使用说明 → 04-故障排除 → 05-FAQ

系统要求

必需环境

  • Python 3.6+ (必需)
  • 操作系统:Windows 10+、macOS 10.14+、Linux Ubuntu 18.04+
  • 存储空间:500MB 可用空间
  • AI工具访问:ChatGPT、Claude等(用于执行AI提示词)

可选环境

  • Bash 4.0+:Linux/macOS用户可选择使用Bash脚本

快速安装

步骤一:下载系统

# 方法1:Git下载
git clone https://github.com/your-repo/AI-Copyright-Application-Generator.git

# 方法2:直接下载ZIP文件后解压

步骤二:验证Python环境

python3 --version
# 确认显示 Python 3.6.x 或更高版本

步骤三:设置权限(Linux/macOS)

cd AI-Copyright-Application-Generator
chmod +x *.py *.sh

步骤四:验证安装

cd AI-Copyright-Application-Generator
python3 scripts/init/init_project.py --help
# 如显示帮助信息,说明安装成功

安装验证

测试系统功能

# 创建测试项目
cd AI-Copyright-Application-Generator
python3 scripts/init/init_project.py test-verification

# 检查生成结果
ls test-verification/

# 清理测试
rm -rf test-verification

检查Python模块

# 验证所需模块(均为Python标准库)
python3 -c "import os, json, shutil, sys; print('✅ Python环境正常')"

依赖说明

无需安装额外包

系统仅使用Python标准库:

  • os - 文件系统操作
  • json - 配置文件处理
  • shutil - 文件复制操作
  • sys - 系统参数处理

推荐工具

  • 文本编辑器:VS Code、Sublime Text、Vim
  • AI访问工具:浏览器或AI工具桌面应用

常见安装问题

Python版本过低

症状SyntaxError: invalid syntax 解决:升级到Python 3.6+

# Ubuntu/Debian
sudo apt install python3.8

# macOS
brew install python@3.8

# Windows:下载官方Python安装包

权限被拒绝

症状Permission denied 解决:设置执行权限

chmod +x *.py *.sh
# 或直接使用:python3 /path/to/AI-Copyright-Application-Generator/scripts/init/init_project.py

找不到python3命令

症状python3: command not found
解决:使用python命令或创建链接

# 检查python版本
python --version
# 如果是3.x版本,用python替代python3

文件目录不完整

症状源文件目录不存在 解决:确保在正确目录运行

# 确认在项目根目录
ls specs_docs/

🔧 进阶配置

全局命令配置(可选)

如果需要在任意目录下使用项目创建命令,可以配置全局访问:

方法一:PATH环境变量

# 临时添加(当前会话有效)
export PATH="$PATH:/path/to/AI-Copyright-Application-Generator"

# 永久添加(加入.bashrc或.zshrc)
echo 'export PATH="$PATH:/path/to/AI-Copyright-Application-Generator"' >> ~/.bashrc
source ~/.bashrc

# 使用全局命令
create-copyright-project "项目名称"

方法二:创建软链接

# 创建软链接到系统PATH
sudo ln -s /path/to/AI-Copyright-Application-Generator/create-copyright-project /usr/local/bin/

# 验证配置
which create-copyright-project

# 使用全局命令
create-copyright-project "项目名称"

方法三:别名配置

# 添加别名到.bashrc或.zshrc
echo 'alias ai-copyright="cd /Users/fancyliu/CursorWorkspace/AI-Copyright-Application-Generator && python3 scripts/init/init_project.py"' >> ~/.bashrc
source ~/.bashrc

# 使用别名
ai-copyright "项目名称"

配置验证

# 测试全局命令
create-copyright-project test-global-project

# 测试在任意目录创建项目
cd /tmp
python3 /path/to/AI-Copyright-Application-Generator/scripts/init/init_project.py test-anywhere

🔍 安装验证

自动化检查(推荐)

使用内置检查脚本验证安装:

# 快速检查安装完整性
cd AI-Copyright-Application-Generator
python3 scripts/validators/check_project.py --quick

# 完整验证(包括语法检查)
python3 scripts/validators/check_project.py

# 功能测试
python3 scripts/validators/run_tests.py

预期结果

  • ✅ 成功率 > 90% - 安装正常
  • ⚠️ 成功率 80-90% - 有警告但可用
  • ❌ 成功率 < 80% - 需要修复问题

手动检查清单

如果无法运行自动检查,请手动确认:

  • Python 3.6+ 可用
  • 脚本有执行权限
  • specs_docs/ 目录存在
  • ai-copyright-config.json 配置文件存在
  • 能成功创建测试项目
  • 有AI工具访问权限
  • 全局命令配置正常(如已配置)

系统升级

升级方法

# 备份现有版本(如有重要项目)
cp -r AI-Copyright-Application-Generator backup/

# 下载新版本
git pull origin main

# 验证升级结果
cd AI-Copyright-Application-Generator
python3 scripts/validators/check_project.py --quick

升级验证

升级完成后建议运行检查:

# 验证所有文件更新正确
cd AI-Copyright-Application-Generator
python3 scripts/validators/check_project.py

# 确认核心功能正常
python3 scripts/validators/run_tests.py

已生成的项目无需特殊处理,可继续使用。


安装完成? 立即开始:01-快速开始.md | 下一步03-使用说明.md