PsyDraw项目使用教程

1. 项目目录结构及介绍

PsyDraw项目的目录结构如下：

psydraw/
├── assets/                # 存放静态资源
├── example/               # 示例文件
├── src/                   # 源代码目录
│   ├── .env_example       # 配置文件示例
│   ├── LICENSE            # 开源协议文件
│   ├── README_CN.md       # 项目中文说明文件
│   ├── deploy.py          # 部署脚本
│   ├── htp_analyzer.py    # HTP分析器
│   ├── htp_analyzer.spec  # 打包配置文件
│   ├── requirements.txt   # 项目依赖
│   ├── run.py             # 项目运行脚本
│   ├── run.sh             # 运行脚本（Shell）
│   ├── web_demo.sh        # Web演示脚本
│   └── zbpack.json        # 打包配置文件
└── ...

• assets/：存放项目所需的静态资源文件，如图片等。
• example/：包含项目使用的示例文件，例如示例图片。
• src/：源代码目录，包含所有项目运行的代码和配置文件。

2. 项目的启动文件介绍

项目的启动主要通过以下文件进行：

• run.py：Python运行脚本，可以通过指定参数运行项目，例如：

  python run.py --image_file example/example1.png --save_path example/example1_result.json --language en
  

• run.sh：Shell脚本，用于快速启动项目，执行以下命令即可运行：

  bash run.sh
  

• web_demo.sh：Shell脚本，用于启动Web演示，执行以下命令即可运行：

  bash web_demo.sh
  

• deploy.py：部署脚本，用于将项目部署到服务器或本地环境，执行以下命令启动服务：

  python deploy.py --port 9557
  

  服务将在 http://127.0.0.1:9557 上运行。

3. 项目的配置文件介绍

项目的主要配置文件为 .env_example，它是一个环境变量配置文件，用于存储项目中可能需要修改的配置项，例如API密钥和基础URL等。在使用前，需要将 .env_example 文件复制并重命名为 .env，然后在 .env 文件中填写相应的配置信息。

配置文件 .env 的基本格式如下：

API_KEY=你的API密钥
BASE_URL=你的基础URL

确保正确配置这些信息，以避免在项目运行时出现配置错误。