v3.2.0

New changes

• Adds Client.get_all_scores
• Adds Room.status

Internal changes

• Adds a fallback for enums that receive invalid values due to api updates

v3.1.0

New changes

• get_replay_data and get_replay_data_by_id_only no longer require user authentication
• add first_image_2x to NewsPost
• update Mod enum with Bloom, NoRelease, Depth, and Cover

v3.0.2

Bug fixes

• Fixes an import error occurring in version without the async feature

v3.0.1

Bug fixes

• Fixes Client.get_friends after a recent change to the return value, which is now a list of UserRelation objects if the api version header is default. Otherwise, if it's before 20241022, then it still returns a list of UserCompact objects.

v3.0.0

New changes

• Added new attributes to UserBeatmapType and updated docs of Client.get_user_beatmaps accordingly.
• Added api_version parameter to Client
• Added set_domain function to `Client
• Added chat endpoints get_channel, craete_announcement_channel, create_pm_channel, get_channel_list, mark_channel_as_read, leave_channel, join_channel, send_message_to_channel, get_channel_messages, create_new_pm, and chat_keepalive to Client
• Added DAILY_CHALLENGE to RoomCategory (yes it's quite late...)
• Change to the output of FunctionalAuthHandler.get_save_data, which now includes the domain

Internal changes

• the logic for url constants was changed to accommodate easily using other domains, such as dev.ppy.sh
• Client will set its domain to the one BaseAuthHandler is using on instantiatiation
• Switched from using python-dateutil to a minimal self-contained util function

Breaking changes

• poll_options parameter on Client.create_topic changed type from Optional[str] to Optional[List[str]]
• aiohttp was moved from requirements.txt to the "async" feature, which can be installed via pip install osu.py[async]

Tests

• added new and updated tests for all changes to Client
• implemented using dev.ppy.sh for certain tests, such as chat and forum

v2.3.2

Bugs

• Fixes support for older versions

Docs

• Slight improvement to docs

v2.3.0

New changes

• Added beatmap and beatmapset to SoloScore
• Added profile_hue to User

Internal changes

• Change logic of get_score_object to rely on type attribute

v2.2.3

Bug fix

• Removes debug code that accidentally made it into the last release

v2.2.2

Deprecations

• key parameter on Client.get_user is deprecated in favor of prefixing usernames with "@"

New

• Added order parameter on BeatmapsetSearchFilter.set_sort
• Added Client.lookup_users

Docs

• Added missing enums on the docs: BeatmapsetSearchSort, BeatmapsetSearchStatus, BeatmapsetSearchExtra, BeatmapsetSearchGeneral, and BeatmapsetSearchPlayed, ``

v2.2.1

Highly recommend switching to this version because of a crucial internal change.

Fixes

• Fix typing for GameModeStr.get_int_equivalent and GameModeInt.get_str_equivalent

Internal changes

• Added get_required function, which prevents key errors on expected data unless testing is in progress. So bugs can be found during testing but won't affect production code.