python-opensubtitles 技术文档

1. 安装指南

1.1 安装正式版本

python-opensubtitles 模块已经发布在 PyPI 上，你可以通过以下命令轻松安装：

pip install python-opensubtitles

1.2 安装开发版本

如果你想从 GitHub 仓库安装最新版本，可以使用以下命令：

pip install -e git+https://github.com/agonzalezro/python-opensubtitles#egg=python-opensubtitles

2. 项目的使用说明

python-opensubtitles 是一个用于访问 OpenSubtitles.org 字幕数据库的简单模块。它封装了 OpenSubtitles API 的常用方法，使得开发者可以轻松地搜索和下载字幕。

2.1 简单使用示例

以下是一个快速下载字幕的示例代码：

from pythonopensubtitles.opensubtitles import OpenSubtitles
from pythonopensubtitles.utils import File

# 初始化 OpenSubtitles 对象
ost = OpenSubtitles()

# 登录 OpenSubtitles 账户
ost.login('你的用户名', '你的密码')

# 创建 File 对象，指定电影文件的路径
f = File('/完整路径/到/电影文件')

# 搜索字幕
data = ost.search_subtitles([{'sublanguageid': 'all', 'moviehash': f.get_hash(), 'moviebytesize': f.size}])

# 获取字幕文件的 ID
id_subtitle_file = data[0].get('IDSubtitleFile')

# 下载字幕文件
ost.download_subtitles([id_subtitle_file], output_directory='/tmp', extension='srt')

2.2 更多信息

如果你想查看更多信息，可以参考项目中的 APPENDIX.md 文件，其中包含了更多的使用示例和测试代码。

3. 项目 API 使用文档

3.1 OpenSubtitles 类

OpenSubtitles 类是 python-opensubtitles 模块的核心类，提供了与 OpenSubtitles API 交互的主要方法。

3.1.1 初始化

ost = OpenSubtitles()

3.1.2 登录

ost.login('用户名', '密码')

3.1.3 搜索字幕

data = ost.search_subtitles([{'sublanguageid': '语言代码', 'moviehash': '电影哈希值', 'moviebytesize': '电影文件大小'}])

3.1.4 下载字幕

ost.download_subtitles([字幕文件ID], output_directory='输出目录', extension='字幕文件扩展名')

3.2 File 类

File 类用于处理电影文件，提供了获取电影哈希值和文件大小的方法。

3.2.1 初始化

f = File('/完整路径/到/电影文件')

3.2.2 获取电影哈希值

hash_value = f.get_hash()

3.2.3 获取电影文件大小

file_size = f.size

4. 项目安装方式

4.1 通过 PyPI 安装

pip install python-opensubtitles

4.2 通过 GitHub 安装

pip install -e git+https://github.com/agonzalezro/python-opensubtitles#egg=python-opensubtitles

4.3 运行测试

如果你想运行项目的测试，可以使用以下命令：

python -m unittest

注意：该项目主要支持 Python 3，早期版本的 Python 可能无法通过所有测试。

---

通过本文档，你应该能够轻松地安装、使用 python-opensubtitles 模块，并了解其 API 的基本使用方法。如果你有更多问题，可以参考项目的 APPENDIX.md 文件或直接查阅 OpenSubtitles API 的官方文档。