Merge pull request #9 from luren-dc/dev

合并 dev 分支

.github/pull_request_template.md

@@ -0,0 +1,49 @@
+<!--
+首先，感谢你的贡献！😄
+
+新特性请提交至 feature 分支，其余可提交至 master 分支。
+在维护者审核通过后会合并。
+请确保填写以下 pull request 的信息，谢谢！~
+-->
+
+### 🤔 这个变动的性质是？
+
+- [ ] 新特性提交
+- [ ] 日常 bug 修复
+- [ ] 站点、文档改进
+- [ ] 性能优化
+- [ ] 功能增强
+- [ ] 重构
+- [ ] 代码风格优化
+- [ ] 测试用例
+- [ ] 分支合并
+- [ ] 工作流程
+- [ ] 其他改动（是关于什么的改动？）
+
+### 🔗 相关 Issue
+
+<!--
+1. 描述相关需求的来源，如相关的 issue 讨论链接。
+2. 例如 close #xxxx、 fix #xxxx
+-->
+
+### 💡 需求背景和解决方案
+
+<!--
+1. 要解决的具体问题。
+2. 列出最终的 API 实现和用法。
+3. 涉及UI/交互变动需要有截图或 GIF。
+-->
+
+### 📝 更新日志
+
+<!--
+从用户角度描述具体变化，以及可能的 breaking change 和其他风险。
+-->
+
+### ☑️ 请求合并前的自查清单
+
+⚠️ 请自检并全部**勾选全部选项**。⚠️
+
+- [ ] 文档已补充或无须补充
+- [ ] 单元测试已提供或无须提供

.github/release-drafter.yml

@@ -0,0 +1,47 @@
+name-template: "v$RESOLVED_VERSION 🌈"
+tag-template: "v$RESOLVED_VERSION"
+categories:
+  - title: "🚀 Features"
+    labels:
+      - "feat"
+      - "feature"
+      - "enhancement"
+      - "kind/feature"
+  - title: "🐛 Bug Fixes"
+    labels:
+      - "fix"
+      - "bugfix"
+      - "bug"
+      - "regression"
+      - "kind/bug"
+  - title: "📝 Documentation updates"
+    labels:
+      - "docs"
+      - "kind/doc"
+  - title: "👻 Maintenance"
+    labels:
+      - "chore"
+      - "dependencies"
+      - "kind/chore"
+      - "kind/dep"
+  - title: "🚦 Tests"
+    labels:
+      - "test"
+      - "tests"
+change-template: "- $TITLE @$AUTHOR (#$NUMBER)"
+change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks.
+version-resolver:
+  major:
+    labels:
+      - "major"
+  minor:
+    labels:
+      - "minor"
+  patch:
+    labels:
+      - "patch"
+  default: patch
+template: |
+  ## What’s Changed
+
+  $CHANGES

.github/workflows/python-publish.yml

@@ -0,0 +1,28 @@
+name: Publish Python Package
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.9"
+      - name: Install Poetry
+        run: |
+          curl -sSL https://install.python-poetry.org | python3 -
+      - name: Install dependencies
+        run: |
+          poetry install
+      - name: Build and publish
+        env:
+          PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
+        run: |
+          poetry build
+          poetry publish --username __token__ --password $PYPI_TOKEN

.github/workflows/release-drafter.yml

@@ -0,0 +1,25 @@
+name: Release Drafter
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types: [opened, reopened, synchronize]
+  pull_request_target:
+     types: [opened, reopened, synchronize]
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  update_release_draft:
+    permissions:
+      contents: write
+      pull-requests: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: release-drafter/release-drafter@v6
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.pre-commit-config.yaml

@@ -0,0 +1,63 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-ast
+      - id: check-builtin-literals
+      - id: check-case-conflict
+      - id: check-docstring-first
+      - id: check-shebang-scripts-are-executable
+      - id: check-merge-conflict
+      - id: check-json
+      - id: check-toml
+      - id: check-xml
+      - id: check-yaml
+      - id: debug-statements
+      - id: destroyed-symlinks
+      - id: detect-private-key
+      - id: end-of-file-fixer
+        exclude: ^LICENSE|\.(html|csv|txt|svg)$
+      - id: pretty-format-json
+        args: [--autofix, --no-ensure-ascii, --no-sort-keys,--indent,"4"]
+      - id: requirements-txt-fixer
+      - id: trailing-whitespace
+        args: [--markdown-linebreak-ext=md]
+        exclude: \.(html|svg)$
+
+  - repo: https://github.com/python-poetry/poetry
+    rev: 1.8.0
+    hooks:
+      - id: poetry-check
+      - id: poetry-lock
+      - additional_dependencies:
+          - poetry-plugin-export
+        args:
+          - -f
+          - requirements.txt
+          - -o
+          - requirements.txt
+        id: poetry-export
+
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.15.2
+    hooks:
+      - id: pyupgrade
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.4.2
+    hooks:
+      - id: ruff
+        args:
+         - --fix
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.9.0
+    hooks:
+      - id: mypy
+        additional_dependencies:
+          - types-requests
+        args:
+          - --check-untyped-defs
+          - --ignore-missing-imports

README.md

@@ -10,6 +10,9 @@
 
 ---
 
+> [!WARNING]
+> 本仓库的所有内容仅供学习和参考之用，禁止用于商业用途。
+
 ## 介绍
 
 使用 Python 编写的用于调用 [QQ音乐](https://y.qq.com/) 各种 API 的库.
@@ -22,6 +25,41 @@
 - [Requests](https://requests.readthedocs.io/)
 - [Cryptography](https://cryptography.io/)
 
+## 快速上手
+
+### 安装
+
+```
+$ pip install qqmusic-api-python
+```
+
+### 使用
+
+```
+import asyncio
+
+from qqmusic_api import search
+
+async def main():
+    # 搜索歌曲
+    result = await search.search_by_type(keyword="周杰伦", num=20)
+    # 打印结果
+    print(result)
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## TODO
+
+- [ ] 歌手 API
+
+## 参考项目
+
+- [Rain120/qq-muisc-api](https://github.com/Rain120/qq-muisc-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/blob/master/LICENSE)**