qqmusic-api-python 0.1.2__tar.gz → 0.1.4__tar.gz

qqmusic_api_python-0.1.4/PKG-INFO

@@ -0,0 +1,110 @@
+Metadata-Version: 2.1
+Name: qqmusic-api-python
+Version: 0.1.4
+Summary: QQ音乐API封装库
+Keywords: music,api,qqmusic,tencentmusic
+Home-page: https://github.com/luren-dc/QQMusicApi
+Author-Email: Luren <68656403+luren-dc@users.noreply.github.com>
+Maintainer-Email: Luren <68656403+luren-dc@users.noreply.github.com>
+License: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Natural Language :: Chinese (Simplified)
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Framework :: Pytest
+Classifier: Framework :: aiohttp
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Project-URL: Homepage, https://github.com/luren-dc/QQMusicApi
+Project-URL: Repository, https://github.com/luren-dc/QQMusicApi
+Project-URL: Documentation, https://github.com/luren-dc/QQMusicApi
+Requires-Python: <4.0,>=3.9
+Requires-Dist: cryptography<42.0.0,>=41.0.2
+Requires-Dist: requests<3.0.0,>=2.31.0
+Requires-Dist: aiohttp<4.0.0,>=3.9.5
+Requires-Dist: typing-extensions>=4.12.2
+Description-Content-Type: text/markdown
+
+<div align="center">
+    <h1> QQMusicApi </h1>
+    <p> Python QQ音乐 API 封装库 </p>
+    <a href="https://www.python.org">
+        <img src="https://img.shields.io/badge/python-3.9+-blue" alt="Python">
+    </a>
+    <a href="https://github.com/astral-sh/ruff">
+        <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff">
+    </a>
+    <a href="https://pdm-project.org">
+        <img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fcdn.jsdelivr.net%2Fgh%2Fpdm-project%2F.github%2Fbadge.json" alt="pdm-managed">
+    </a>
+    <a href="https://github.com/luren-dc/QQMusicApi/tree/build?tab=License-1-ov-file">
+        <img src="https://img.shields.io/github/license/luren-dc/PyQQMusicApi" alt="GitHub license">
+    </a>
+    <a href="https://github.com/luren-dc/QQMusicApi/stargazers">
+        <img src="https://img.shields.io/github/stars/luren-dc/QQMusicApi?color=yellow&label=Github%20Stars" alt="STARS">
+    </a>
+    <a href="https://github.com/luren-dc/QQMusicApi/actions/workflows/testing.yml">
+        <img src="https://github.com/luren-dc/QQMusicApi/actions/workflows/testing.yml/badge.svg?branch=dev" alt="Testing">
+    </a>
+</div>
+
+---
+
+> [!WARNING]
+> 本仓库的所有内容仅供学习和参考之用，禁止用于商业用途
+
+**文档**: <a href="https://luren-dc.github.io/QQMusicApi" target="_blank">https://luren-dc.github.io/QQMusicApi</a>
+
+**源代码**: <a href="https://github.com/luren-dc/QQMusicApi" target="_blank">https://github.com/luren-dc/QQMusicApi</a>
+
+## 介绍
+
+使用 Python 编写的用于调用 [QQ音乐](https://y.qq.com/) 各种 API 的库.
+
+## 特色
+
+- 涵盖常见 API
+- 调用简便，函数命名易懂，代码注释详细
+- 异步操作
+
+## 依赖
+
+- [AIOHTTP](https://docs.aiohttp.org/)
+- [Requests](https://requests.readthedocs.io/)
+- [Cryptography](https://cryptography.io/)
+
+## 快速上手
+
+### 安装
+
+```bash
+pip install qqmusic-api-python
+```
+
+### 使用
+
+```python
+import asyncio
+
+from qqmusic_api import search
+
+async def main():
+    # 搜索歌曲
+    result = await search.search_by_type(keyword="周杰伦", num=20)
+    # 打印结果
+    print(result)
+
+asyncio.run(main())
+```
+
+## 参考项目
+
+- [Rain120/qq-muisc-api](https://github.com/Rain120/qq-music-api)
+- [jsososo/QQMusicApi](https://github.com/jsososo/QQMusicApi)
+- [Nemo2011/bilibili-api](https://github.com/Nemo2011/bilibili-api/)
+
+## Licence
+
+**[MIT License](https://github.com/luren-dc/QQMusicApi?tab=MIT-1-ov-file)**

qqmusic_api_python-0.1.4/README.md

@@ -0,0 +1,81 @@
+<div align="center">
+    <h1> QQMusicApi </h1>
+    <p> Python QQ音乐 API 封装库 </p>
+    <a href="https://www.python.org">
+        <img src="https://img.shields.io/badge/python-3.9+-blue" alt="Python">
+    </a>
+    <a href="https://github.com/astral-sh/ruff">
+        <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff">
+    </a>
+    <a href="https://pdm-project.org">
+        <img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fcdn.jsdelivr.net%2Fgh%2Fpdm-project%2F.github%2Fbadge.json" alt="pdm-managed">
+    </a>
+    <a href="https://github.com/luren-dc/QQMusicApi/tree/build?tab=License-1-ov-file">
+        <img src="https://img.shields.io/github/license/luren-dc/PyQQMusicApi" alt="GitHub license">
+    </a>
+    <a href="https://github.com/luren-dc/QQMusicApi/stargazers">
+        <img src="https://img.shields.io/github/stars/luren-dc/QQMusicApi?color=yellow&label=Github%20Stars" alt="STARS">
+    </a>
+    <a href="https://github.com/luren-dc/QQMusicApi/actions/workflows/testing.yml">
+        <img src="https://github.com/luren-dc/QQMusicApi/actions/workflows/testing.yml/badge.svg?branch=dev" alt="Testing">
+    </a>
+</div>
+
+---
+
+> [!WARNING]
+> 本仓库的所有内容仅供学习和参考之用，禁止用于商业用途
+
+**文档**: <a href="https://luren-dc.github.io/QQMusicApi" target="_blank">https://luren-dc.github.io/QQMusicApi</a>
+
+**源代码**: <a href="https://github.com/luren-dc/QQMusicApi" target="_blank">https://github.com/luren-dc/QQMusicApi</a>
+
+## 介绍
+
+使用 Python 编写的用于调用 [QQ音乐](https://y.qq.com/) 各种 API 的库.
+
+## 特色
+
+- 涵盖常见 API
+- 调用简便，函数命名易懂，代码注释详细
+- 异步操作
+
+## 依赖
+
+- [AIOHTTP](https://docs.aiohttp.org/)
+- [Requests](https://requests.readthedocs.io/)
+- [Cryptography](https://cryptography.io/)
+
+## 快速上手
+
+### 安装
+
+```bash
+pip install qqmusic-api-python
+```
+
+### 使用
+
+```python
+import asyncio
+
+from qqmusic_api import search
+
+async def main():
+    # 搜索歌曲
+    result = await search.search_by_type(keyword="周杰伦", num=20)
+    # 打印结果
+    print(result)
+
+asyncio.run(main())
+```
+
+## 参考项目
+
+- [Rain120/qq-muisc-api](https://github.com/Rain120/qq-music-api)
+- [jsososo/QQMusicApi](https://github.com/jsososo/QQMusicApi)
+- [Nemo2011/bilibili-api](https://github.com/Nemo2011/bilibili-api/)
+
+## Licence
+
+**[MIT License](https://github.com/luren-dc/QQMusicApi?tab=MIT-1-ov-file)**

qqmusic_api_python-0.1.4/pyproject.toml

@@ -0,0 +1,148 @@
+[build-system]
+requires = [
+    "pdm-backend",
+]
+build-backend = "pdm.backend"
+
+[project]
+name = "qqmusic-api-python"
+description = "QQ音乐API封装库"
+authors = [
+    { name = "Luren", email = "68656403+luren-dc@users.noreply.github.com" },
+]
+dependencies = [
+    "cryptography<42.0.0,>=41.0.2",
+    "requests<3.0.0,>=2.31.0",
+    "aiohttp<4.0.0,>=3.9.5",
+    "typing-extensions>=4.12.2",
+]
+requires-python = "<4.0,>=3.9"
+readme = "README.md"
+maintainers = [
+    { name = "Luren", email = "68656403+luren-dc@users.noreply.github.com" },
+]
+keywords = [
+    "music",
+    "api",
+    "qqmusic",
+    "tencentmusic",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Natural Language :: Chinese (Simplified)",
+    "License :: OSI Approved :: MIT License",
+    "Framework :: Pytest",
+    "Framework :: aiohttp",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dynamic = []
+version = "0.1.4"
+
+[project.license]
+text = "MIT"
+
+[project.urls]
+homepage = "https://github.com/luren-dc/QQMusicApi"
+repository = "https://github.com/luren-dc/QQMusicApi"
+documentation = "https://github.com/luren-dc/QQMusicApi"
+
+[tool.pdm]
+distribution = true
+
+[tool.pdm.version]
+source = "file"
+path = "qqmusic_api/__init__.py"
+
+[tool.pdm.dev-dependencies]
+testing = [
+    "pytest<9.0.0,>=8.2.0",
+    "pytest-asyncio<1.0.0,>=0.23.6",
+    "pytest-sugar<2.0.0,>=1.0.0",
+]
+docs = [
+    "mkdocs-material>=9.5.29",
+    "mkdocstrings-python>=1.10.5",
+    "mkdocstrings>=0.25.1",
+    "mkdocs>=1.6.0",
+    "markdown-callouts>=0.4.0",
+    "griffe-inherited-docstrings>=1.0.0",
+]
+mypy = [
+    "mypy>=1.11.0",
+    "types-requests>=2.32.0.20240712",
+]
+linting = [
+    "ruff>=0.5.4",
+]
+
+[tool.pdm.build]
+source-includes = [
+    "qqmusic_api",
+    "README.md",
+    "LICENSE",
+    "tests",
+]
+
+[tool.pdm.scripts]
+docs = "mkdocs serve"
+
+[tool.mypy]
+pretty = true
+python_version = 3.9
+show_column_numbers = true
+
+[tool.ruff]
+line-length = 120
+target-version = "py39"
+
+[tool.ruff.format]
+docstring-code-format = true
+
+[tool.ruff.lint]
+extend-select = [
+    "Q",
+    "RUF100",
+    "C90",
+    "UP",
+    "I",
+    "D",
+    "T",
+]
+extend-ignore = [
+    "D105",
+    "D107",
+    "D205",
+    "D415",
+]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.ruff.lint.per-file-ignores]
+"docs/*" = [
+    "D",
+]
+"tests/*" = [
+    "D",
+]
+"qqmusic_api/__init__.py" = [
+    "F405",
+    "F403",
+    "D",
+]
+"qqmusic_api/**/__init__.py" = [
+    "F405",
+    "F403",
+    "D",
+]
+
+[tool.pytest.ini_options]
+pythonpath = "./"
+testpaths = [
+    "tests",
+]
+asyncio_mode = "auto"

{qqmusic_api_python-0.1.2 → qqmusic_api_python-0.1.4}/qqmusic_api/__init__.py

@@ -2,6 +2,8 @@ from . import album, login, mv, search, singer, song, songlist, top
 from .utils.credential import Credential
 from .utils.network import get_aiohttp_session, set_aiohttp_session
 
+__version__ = "0.1.4"
+
 __all__ = [
     "album",
     "Credential",

{qqmusic_api_python-0.1.2 → qqmusic_api_python-0.1.4}/qqmusic_api/album.py

@@ -1,3 +1,5 @@
+"""专辑相关 API"""
+
 from .song import Song
 from .utils.network import Api
 from .utils.utils import get_api
@@ -6,12 +8,15 @@ API = get_api("album")
 
 
 class Album:
-    """
-    专辑类
+    """专辑类
+
+    Attributes:
+        mid: 专辑 mid
     """
 
     def __init__(self, mid: str):
-        """
+        """初始化专辑类
+
         Args:
             mid: 专辑 mid
         """
@@ -21,18 +26,18 @@ class Album:
         return f"Album(mid={self.mid})"
 
     async def get_detail(self) -> dict:
-        """
+        """获取专辑详细信息
+
         Returns:
-            dict: 专辑详细信息
+            专辑详细信息
         """
         return await Api(**API["detail"]).update_params(albumMid=self.mid).result
 
     async def get_song(self) -> list[Song]:
-        """
-        获取专辑歌曲
+        """获取专辑歌曲
 
         Returns:
-            list: 歌曲列表
+            歌曲列表
         """
         result = await Api(**API["song"]).update_params(albumMid=self.mid, begin=0, num=0).result
         return [Song.from_dict(song["songInfo"]) for song in result["songList"]]

{qqmusic_api_python-0.1.2 → qqmusic_api_python-0.1.4}/qqmusic_api/exceptions/ApiException.py

@@ -1,7 +1,8 @@
+"""API 基类异常"""
+
+
 class ApiException(Exception):
-    """
-    API 基类异常。
-    """
+    """API 基类异常。"""
 
     def __init__(self, msg: str = "出现了错误，但是未说明具体原因"):
         super().__init__(msg)

{qqmusic_api_python-0.1.2 → qqmusic_api_python-0.1.4}/qqmusic_api/exceptions/CredentialNoMusicidException.py

@@ -1,6 +1,10 @@
+"""Credential 未提供 musicid 或为空"""
+
 from .ApiException import ApiException
 
 
 class CredentialNoMusicidException(ApiException):
+    """Credential 未提供 musicid 或为空"""
+
     def __init__(self):
         super().__init__("Credential 未提供 musicid 或为空")

{qqmusic_api_python-0.1.2 → qqmusic_api_python-0.1.4}/qqmusic_api/exceptions/CredentialNoMusickeyException.py

@@ -1,6 +1,10 @@
+"""Credential 未提供 musickey 或为空"""
+
 from .ApiException import ApiException
 
 
 class CredentialNoMusickeyException(ApiException):
+    """Credential 未提供 musickey 或为空"""
+
     def __init__(self):
         super().__init__("Credential 未提供 musickey 或为空")

{qqmusic_api_python-0.1.2 → qqmusic_api_python-0.1.4}/qqmusic_api/exceptions/CredentialNoRefreshkeyException.py

@@ -1,6 +1,10 @@
+"""Credential 未提供 refreshkey 或为空"""
+
 from .ApiException import ApiException
 
 
 class CredentialNoRefreshkeyException(ApiException):
+    """Credential 未提供 refreshkey 或为空"""
+
     def __init__(self):
         super().__init__("Credential 未提供 refreshkey 或为空")

{qqmusic_api_python-0.1.2 → qqmusic_api_python-0.1.4}/qqmusic_api/exceptions/LoginException.py

@@ -1,6 +1,10 @@
+"""登录异常"""
+
 from .ApiException import ApiException
 
 
 class LoginException(ApiException):
+    """登录失败"""
+
     def __init__(self, msg: str):
         super().__init__(msg)

{qqmusic_api_python-0.1.2 → qqmusic_api_python-0.1.4}/qqmusic_api/exceptions/ResponseCodeException.py

@@ -1,15 +1,16 @@
+"""API 返回 code 错误"""
+
 from typing import Optional
 
 from .ApiException import ApiException
 
 
 class ResponseCodeException(ApiException):
-    """
-    API 返回 code 错误。
-    """
+    """API 返回 code 错误"""
 
     def __init__(self, code: int, msg: str, raw: Optional[dict] = None):
-        """
+        """初始化错误类
+
         Args:
             code: 错误代码
             msg: 错误信息