Syrics 项目使用教程

1. 项目目录结构及介绍

Syrics 是一个命令行工具，用于从 Spotify 获取歌词并保存为 LRC 文件。以下是项目的目录结构及其介绍：

syrics/
├── github/
│   └── workflows/
│       └── syrics.yml
├── .gitignore
├── LICENSE
├── README.md
├── requirements.txt
├── setup.cfg
├── setup.py
└── syrics/
    ├── __init__.py
    ├── api.py
    ├── config.py
    ├── main.py
    └── utils.py

目录结构说明

• github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• .gitignore: 指定 Git 忽略的文件和目录。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍和使用说明。
• requirements.txt: 项目依赖的 Python 包列表。
• setup.cfg: 项目的配置文件。
• setup.py: 用于安装项目的脚本。
• syrics/: 项目的主要代码目录。
  • init.py: 初始化文件。
  • api.py: 包含与 Spotify API 交互的代码。
  • config.py: 配置文件处理代码。
  • main.py: 项目的启动文件。
  • utils.py: 包含一些工具函数。

2. 项目的启动文件介绍

项目的启动文件是 syrics/main.py。该文件包含了主要的逻辑代码，用于处理用户输入、调用 API 获取歌词并保存为 LRC 文件。

主要功能

• 命令行参数解析: 解析用户输入的命令行参数。
• 配置文件加载: 加载并解析配置文件。
• 歌词获取: 调用 api.py 中的函数从 Spotify 获取歌词。
• 歌词保存: 将获取的歌词保存为 LRC 文件。

3. 项目的配置文件介绍

项目的配置文件是通过 syrics --config 命令生成的。默认情况下，配置文件会保存在用户的主目录下。

配置文件内容

{
  "sp_dc": "",
  "download_path": "downloads",
  "create_folder": true,
  "album_folder_name": "[name] - [artists]",
  "play_folder_name": "[name] - [owner]",
  "file_name": "[track_number] - [name]",
  "synced_lyrics": true,
  "force_download": false,
  "force_synced": false
}

配置项说明

• sp_dc: Spotify 的认证 Cookie，用于访问 Spotify 的 API。
• download_path: 歌词文件的下载路径。
• create_folder: 是否为每个专辑或播放列表创建单独的文件夹。
• album_folder_name: 专辑文件夹的命名格式。
• play_folder_name: 播放列表文件夹的命名格式。
• file_name: 歌词文件的命名格式。
• synced_lyrics: 是否下载同步歌词。
• force_download: 是否强制重新下载歌词。
• force_synced: 是否强制下载同步歌词。

通过编辑配置文件，用户可以自定义歌词的下载路径、文件命名格式等。