Headphones 项目技术文档

1. 安装指南

1.1 系统要求

• Python 2.7 或更高版本
• 支持的操作系统：Linux, macOS, Windows

1.2 安装步骤

1. 克隆项目仓库到本地：

   git clone https://github.com/rembo10/headphones.git
   

2. 进入项目目录：

   cd headphones
   

3. 安装依赖：

   pip install -r requirements.txt
   

4. 启动 Headphones：

   python Headphones.py
   

2. 项目使用说明

2.1 启动与访问

• 启动 Headphones 后，默认会在本地运行，访问地址为 http://localhost:8181。
• 首次访问时，系统会引导你进行基本配置。

2.2 基本功能

• 艺术家管理：添加和管理你喜欢的艺术家。
• 自动下载：Headphones 会自动搜索并下载你指定的音乐。
• 下载器支持：支持 SABnzbd, NZBget, Transmission, µTorrent, Deluge 和 Blackhole。

2.3 配置

• 在设置页面中，你可以配置下载器、音乐库路径、通知设置等。

3. 项目API使用文档

3.1 API 概述

Headphones 提供了一系列 API 接口，用于外部程序与 Headphones 进行交互。

3.2 常用API

• 获取艺术家列表：

  GET /api/artists
  

• 添加艺术家：

  POST /api/addartist
  

• 获取专辑信息：

  GET /api/albuminfo
  

3.3 API 认证

• 使用 API 时，需要提供 API Key 进行认证。API Key 可以在设置页面中生成。

4. 项目安装方式

4.1 手动安装

• 按照上述安装指南中的步骤进行安装。

4.2 Docker 安装

• 使用 Docker 镜像进行安装：

  docker pull rembo10/headphones
  docker run -d -p 8181:8181 rembo10/headphones
  

4.3 其他安装方式

• 参考项目 Wiki 中的 Installation page 获取更多安装方式。

---

通过以上文档，你应该能够顺利安装、配置和使用 Headphones 项目。如果在使用过程中遇到问题，可以参考项目 Wiki 中的 Troubleshooting page 进行排查。