BizyAir 项目使用教程

BizyAir 项目使用教程

BizyAir BizyAir: Comfy Nodes that can run in any environment. 项目地址: https://gitcode.com/gh_mirrors/bi/BizyAir

1. 项目目录结构及介绍

BizyAir 项目的目录结构如下：

BizyAir/
├── .github/                     # GitHub 工作流和配置文件
├── backend/                     # 后端代码目录
├── docs/                        # 项目文档目录
├── examples/                    # 示例工作流和配置文件
├── frontend/                    # 前端代码目录
├── tests-units/                 # 单元测试代码目录
├── tests/                       # 测试代码目录
├── tools/                       # 工具和脚本目录
├── .flake8                      # Python 代码风格配置文件
├── .gitignore                   # Git 忽略文件列表
├── .gitmodules                  # Git 子模块配置文件
├── .pre-commit-config.yaml      # 预提交钩子配置文件
├── LICENSE                      # 项目许可证文件
├── README.md                    # 项目说明文件
├── __init__.py                  # Python 包初始化文件
├── api_key.ini.example          # API 密钥配置示例文件
├── dev_requirements.txt         # 开发环境依赖文件
├── increment_version.py         # 版本增加脚本
├── prestartup_script.py         # 启动前脚本
├── pyproject.toml               # Python 项目配置文件
├── pytest.ini                   # pytest 测试配置文件
├── requirements.txt             # 项目依赖文件

• .github/: 包含项目的 GitHub 工作流和配置文件。
• backend/: 包含项目的后端代码。
• docs/: 包含项目的文档。
• examples/: 包含示例工作流和配置文件。
• frontend/: 包含项目的前端代码。
• tests-units/: 包含单元测试代码。
• tests/: 包含测试代码。
• tools/: 包含工具和脚本。
• .flake8: Python 代码风格配置文件。
• .gitignore: Git 忽略文件列表。
• .gitmodules: Git 子模块配置文件。
• .pre-commit-config.yaml: 预提交钩子配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• __init__.py: Python 包初始化文件。
• api_key.ini.example: API 密钥配置示例文件。
• dev_requirements.txt: 开发环境依赖文件。
• increment_version.py: 版本增加脚本。
• prestartup_script.py: 启动前脚本。
• pyproject.toml: Python 项目配置文件。
• pytest.ini: pytest 测试配置文件。
• requirements.txt: 项目依赖文件。

2. 项目的启动文件介绍

项目的启动文件主要是 prestartup_script.py。这个脚本在项目启动前执行，用于进行一些初始化工作，例如加载配置文件、设置环境变量等。

3. 项目的配置文件介绍

项目的配置文件主要包括以下几个：

• api_key.ini.example: 这是一个示例配置文件，用于存放 API 密钥。在使用时，用户需要根据实际情况填写自己的 API 密钥，并将其重命名为 api_key.ini。
• dev_requirements.txt: 包含开发环境下的依赖包列表。在开发过程中，需要安装这些依赖包以确保项目可以正常运行。
• requirements.txt: 包含项目运行所需的依赖包列表。在部署项目时，需要安装这些依赖包。

用户需要根据自己的需求修改这些配置文件，以确保项目能够正确运行。

BizyAir BizyAir: Comfy Nodes that can run in any environment. 项目地址: https://gitcode.com/gh_mirrors/bi/BizyAir