Bestdori-api
✨ Bestdori 的各种 API 调用整合，另外附带部分功能 ✨
:warning: 该项目仍然急需更新与 Debug ，使用时若遇到 Bug 或其他需要的接口请及时提出
bestdori-api 现已全面支持同步与异步 异步使用方法与同步类似，可几乎无缝切换
:boom: 破坏性变更（近期版本）
自本次重构起，所有公开 API 接口已移除 me 参数（例如 get_all(..., me=...)、Upload.from_path(..., me=...)、EventTracker(..., me=...) 等）。
调整原因：
- 统一鉴权：改为通过一次登录后设置全局
Api.set_cookies(...)维持会话，避免每次调用显式传参。 - 简化接口：绝大多数只读接口与资源获取与用户状态无关，移除多余可选参数降低心智负担。
- 规避误用：此前传入不同
Me实例造成的状态不一致/缓存混乱问题被彻底消除。
迁移指南：
- 删除所有函数/方法调用里的
me=...关键字参数。 - 若需要登录态（发表帖子 / 上传等），在程序启动阶段：
from bestdori.user import Me
me = Me(username, password)
me.login() # 或 await me.login_async()
# 之后直接调用其它 API，不再传递 me
- 原
User(..., me=...)、EventTracker(..., me=...)、Upload(..., me=...)构造签名均已精简为不含me版本。 - 若你维护文档 / 代码片段，请移除所有
me=示例。
影响范围（非完整列表）：characters, cards, costumes, events, eventarchives, eventtracker, eventtop, gacha, logincampaigns, missions, songmeta, songs, skills, festival, miracleticket, stamps, upload, bands, post 相关查询/评论接口，以及对应异步版本。
旧版本兼容：不再提供回退层；若需要过渡，请锁定升级前版本号。
如在迁移过程中遇到问题，欢迎提交 Issue。
简介
这是一个用 Python 编写的调用 Bestdori 各种 API 与资源下载的库，大致包括了社区帖子的处理以及各种 BanG Dream！少女乐团派对 游戏内资源的获取。 警告：此模块目前仍然亟待完善与测试，请不要将其当做一个稳定的库使用。
目前已有的 API 与功能
| API 类别 | 是否完善 | 支持的内容 |
|---|---|---|
| 用户 | 👍👍 | 登录、查询、帖子获取、信息获取 |
| 玩家 | 👍 | 信息获取 |
| 帖子 | 👍👍👍 | 搜索、获取、发表、评论、喜欢 |
| 谱面 | 👍👍👍 | 社区谱面获取、音源与封面获取、规整化、数据统计、格式互转 |
| 故事 | 👍 | 社区故事获取 |
| 角色 | 👍👍 | 信息获取、资源获取 |
| 卡牌 | 👍👍 | 信息获取、资源获取 |
| 服装 | 👍👍 | 信息获取、资源获取 |
| 活动 | 👍👍 | 信息获取、资源获取 |
| 活动数据 | 👍👍 | 数据获取 |
| 招募 | 👍👍 | 数据获取、资源获取 |
| 歌曲 | 👍👍 | 信息获取、资源获取 |
| 歌曲 Meta | 👍 | 数据获取 |
| 登录奖励 | 👍👍 | 信息获取、资源获取 |
| 自选券 | 👍 | 信息获取 |
| 漫画 | 👍👍 | 信息获取、图片获取 |
| 任务 | 👍 | 信息获取 |
| ayachan | 👍👍👍 | 谱面分析、测试服上传、难度分析 |
| 其他资源 | 👍 | 部分独立资源的单独获取 |
快速使用
以下将以获取社区自制谱面 [FULL] 光の中へ 的信息为例。
首先，使用以下指令安装本模块：
$ pip3 install bestdori-api
接下来在一个 Python 脚本文件中，使用如下代码获取指定帖子的全部信息（这里我们已知该帖子的 ID 为 111533）：
from bestdori.post import Post
def main() -> None:
# 实例化 Post 类
p = Post(id='111533')
# 调用方法获取信息
info = p.get_details()
# 打印信息
print(info)
main()
得到的输出内容如下：
{
'categoryName': 'SELF_POST',
'categoryId': 'chart',
'title': '[FULL] 光の中へ',
'song': {
'type': 'custom',
'audio': 'https://bestdori.com/api/upload/file/e4a080f84bfa2ca47b23b390a464c819ec17e70b',
'cover': 'https://bestdori.com/api/upload/file/e3535ebb4c740c4757371026a1df9ffb08010307'
},
'artists': '結束バンド',
'diff': 4,
'level': 30,
'chart': [
{
'bpm': 191,
'beat': 0,
'type': 'BPM'
},
{
'beat': 192,
'lane': 3.
'type': 'Single'
},
...
],
...
}
如果想要获取这个自制谱面的谱面，或者想要获取它的音源与封面，以下代码将会进行获取：
from bestdori.post import Post
def main() -> None:
# 实例化 Post 类
p = Post(id='111533')
# 调用方法获取谱面
chart = p.get_chart() # 获取的将是一个谱面实例
# 调用方法获取音源与封面
info = p.get_song() # 获取的将是一个包含了音源与封面的 bytes 字典
main()
1 maintainer
Metadata
1 maintainer
Release files for bestdori-api 2.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| bestdori_api-2.2.0.tar.gz | 55.4 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| bestdori_api-2.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 133.0 kB
Release files / bestdori_api-2.2.0.tar.gz
| Download URL | bestdori_api-2.2.0.tar.gz |
|---|---|
| Size | 55.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6e548ee790587fe12f622f681789a575fe610ae499cef8ecf98b61b5d8e00937
|
|
BLAKE2b-256 checksum How to use checksums |
71b1207c6699f7a7b9a8fd9558fcfd03a13d09bbcc76bf4b2f4623dff188247a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.10.19
|
Release files / bestdori_api-2.2.0-py3-none-any.whl
| Download URL | bestdori_api-2.2.0-py3-none-any.whl |
|---|---|
| Size | 77.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7df4059c19a2661e2a95fb5078607afdc1d12dc5f037347b4ffd9e596640619e
|
|
BLAKE2b-256 checksum How to use checksums |
3afbadf2ebd0bee1e1f355e2092ffa6b921972be4fcf3c99dc59c8f068bd143e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.10.19
|
Security for bestdori-api 2.2.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
