Comet项目使用教程

1. 项目目录结构及介绍

Comet项目的目录结构如下所示：

comet/
├── .github/
│   └── workflows/
├── deployment/
│   └── docker-compose.yml
├── .env-sample
├── .gitignore
├── CHANGELOG.md
├── Dockerfile
├── LICENSE
├── README.md
├── docker-compose.yaml
├── pyproject.toml
└── comet/
    ├── __init__.py
    ├── main.py
    ├── ... (其他模块文件)

• .github/workflows/: 存放GitHub Actions的工作流文件，用于自动化项目的一些操作，如自动部署、测试等。
• deployment/: 存放与部署相关的配置文件，例如Docker部署的docker-compose.yml文件。
• .env-sample: 项目环境变量的示例文件，用于展示如何配置环境变量。
• .gitignore: 指定Git应该忽略的文件和目录。
• CHANGELOG.md: 记录了项目的更新历史和版本变更。
• Dockerfile: 用于构建Docker镜像的文件。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的说明文件，包含了项目的基本信息和如何使用。
• pyproject.toml: 包含了项目的元数据和依赖关系。

2.项目的启动文件介绍

项目的启动主要通过comet/main.py文件进行。

# main.py
from comet import create_app

app = create_app()

if __name__ == "__main__":
    app.run()

在main.py中，首先从comet模块中导入create_app函数，然后调用该函数创建应用实例。如果该文件是作为主程序运行，则启动Flask应用。

3.项目的配置文件介绍

项目的配置文件主要是.env-sample，该文件中包含了项目运行所需的环境变量。在使用时，用户需要根据自己的需求修改.env-sample文件，并重命名为.env。

以下是.env-sample文件的部分内容示例：

# .env-sample
DEBUG=1
SECRET_KEY=your_secret_key
DATABASE_URL=sqlite:///comet.db
INDEXER_MANAGER_TYPE=jackett

• DEBUG: 设置是否开启调试模式。
• SECRET_KEY: Flask应用的密钥，用于安全相关的操作。
• DATABASE_URL: 数据库的URL，这里使用SQLite作为默认数据库。
• INDEXER_MANAGER_TYPE: 设置索引管理器的类型，可以是jackett或prowlarr。

用户需要根据自己的需求和环境，将.env-sample中的示例值替换为实际值，并去除行前的注释符号。