PlexBackup 项目使用教程

1. 项目的目录结构及介绍

PlexBackup 项目的目录结构如下：

PlexBackup/
├── README.md
├── PlexBackup.py
├── config.yaml
├── requirements.txt
└── tests/
    └── test_PlexBackup.py

• README.md: 项目说明文档，包含项目的基本信息和使用方法。
• PlexBackup.py: 项目的启动文件，包含主要的备份逻辑。
• config.yaml: 项目的配置文件，用于设置备份的相关参数。
• requirements.txt: 项目依赖的 Python 包列表。
• tests/: 包含项目的测试文件。

2. 项目的启动文件介绍

PlexBackup.py 是项目的启动文件，主要功能是执行 Plex Media Server 的备份操作。以下是该文件的主要内容和功能介绍：

import os
import yaml
from datetime import datetime

# 读取配置文件
with open('config.yaml', 'r') as file:
    config = yaml.safe_load(file)

# 备份函数
def backup_plex():
    backup_dir = config['backup_dir']
    plex_data_dir = config['plex_data_dir']
    timestamp = datetime.now().strftime('%Y%m%d%H%M%S')
    backup_file = f'{backup_dir}/plex_backup_{timestamp}.tar.gz'
    
    # 执行备份命令
    os.system(f'tar -czf {backup_file} -C {plex_data_dir} .')
    print(f'Backup completed: {backup_file}')

if __name__ == '__main__':
    backup_plex()

• import 语句：导入所需的模块。
• 读取配置文件：读取 config.yaml 文件中的配置信息。
• 备份函数：定义备份函数 backup_plex，该函数会根据配置文件中的路径执行备份操作。
• 主程序：当文件作为主程序运行时，调用 backup_plex 函数执行备份。

3. 项目的配置文件介绍

config.yaml 是项目的配置文件，用于设置备份的相关参数。以下是该文件的内容示例：

backup_dir: '/path/to/backup/directory'
plex_data_dir: '/path/to/plex/data/directory'

• backup_dir: 指定备份文件的存储路径。
• plex_data_dir: 指定 Plex Media Server 数据目录的路径。

通过修改 config.yaml 文件中的路径，可以自定义备份文件的存储位置和 Plex Media Server 数据目录的位置。