Repository files navigation

The definitive python wrapper for MaimaiCN related development, wrapping the frequently used methods from DivingFish and LXNS.

We provide data models and methods based on MaiMai standard, and make implementation for both DivingFish and LXNS.

Support querying songs, player information, scores, ratings, name plates from any data sources.

In addition, we support getting player scores with WeChat OpenID, parsing the score HTML, and uploading it to the data sources.

pip install maimai-py

To upgrade:

pip install -U maimai-py

For more, read the docs:https://maimai.turou.fun/.

Additionally, you candownload the maimai.py client and develop using any programming language.

importasynciofrommaimai_pyimportMaimaiClient,MaimaiPlates,MaimaiScores,MaimaiSongs,PlayerIdentifier,LXNSProvider,DivingFishProviderasyncdefquick_start():maimai=MaimaiClient()divingfish=DivingFishProvider(developer_token="")# fetch all songs and their metadatasongs:MaimaiSongs=awaitmaimai.songs()# fetch divingfish user turou's scores (b50 scores by default)scores:MaimaiScores=awaitmaimai.scores(PlayerIdentifier(username="turou"),provider=divingfish)# fetch divingfish user turou's 舞将 plate informationplates:MaimaiPlates=awaitmaimai.plates(PlayerIdentifier(username="turou"),"舞将",provider=divingfish)song=songs.by_id(1231)# 生命不詳 by 蜂屋ななしprint(f"Song 1231:{song.artist} -{song.title}")print(f"TuRou's rating:{scores.rating}, b15 top rating:{scores.scores_b15[0].dx_rating}")print(f"TuRou's 舞将:{plates.cleared_num}/{plates.all_num} cleared")asyncio.run(quick_start())

maimai.py is fully asynchronous by default, and there are no plans to provide synchronous methods.

If you don't want to be asynchronous, you can use theasyncio.run wrapper to call asynchronous methods synchronously.

maimai.py provides a RESTful API client, which you can call maimai.py features via HTTP requests from any language.

The client is compiled using Nuitka, please download it from theReleases page.

Our client supports Windows and Linux, please download the corresponding version according to your system.

For the client API documentation, please see:https://openapi.maimai.turou.fun/.