Releases: Sheppsu/osu.py
Releases · Sheppsu/osu.py
v2.2.0
Changes
- Deprecated
Client.from_client_credentialsin favor ofClient.from_credentialsand same forAsynchronousClient.from_credentials, which has a new parameterlazily_authenticatethat determines whether to immediately authenticate or not (defaults to lazy). Additionally,AsynchronousClient.from_credentialsis no longer asynchronous, but returns an awaitable if lazily_authenticate is false.
New
- Added
UserScoreType.PINNED - Added
User.daily_challenge_user_statsandDailyChallengeUserStats
v2.1.2
v2.1.1
This version complies with changes to beatmapset nomination requirements
BeatmapsetRequirementhas two new optional attributes:eligible_main_rulesetsandrequired_metaandrequiredis now optional- Added
BeatmapsetRequiredNominationsas the type ofrequired_meta
v2.1.0
v2.0.2
v2.0.1
v2.0.0
Breaking changes
- Remove support for endpoints requiring the lazer scope, which no longer works anyways
- Remove anything involving lazer.ppy.sh
AsynchronousClient.from_client_credentialsis asynchronous
New changes
- Add
Client.set_api_version - Create
BaseAuthHandlerand change some internals to reference it - Create
AsynchronousAuthHandlerforAsynchronousClient - Added
__slots__toClient - Added
active_tournament_bannersforUser - Added
Client.get_score_by_id_only - Added
__len__and__iter__toBeatmapScores
Other stuff
- websockets and osrparse requirements are now under their own features: replay and notifications respectively
v1.2.0
Bug fixes
- fixed
BaseNominations.nominated,ranking_eta, andranking_queue_positionnot being optional - added
CurrentNominationand fixedBeatmapsetCompact.current_nominationstype
New changes
- added
download_beatmapsetendpoint get_scorehas been removed because the endpoint was removed (not marking as breaking because a 404 error would be raised anyway)- renamed
LegacyScore.replaytohas_replaybecause replay has been deprecated in favor ofhas_replay(thoughLegacyScorehas areplayproperty for backwards compatibility) - added UserBadge.image_2x_url
- added aiofiles to requirements.txt
Internal changes
- replace use of
time.perf_counterwithmonotonic - added
make_request_to_endpointandmake_requestwrapper for it - removed
is_downloadfrom asyncmake_request_to_endpointandallow_redirectfrom both sync and async
v1.1.0
New changes
- Implement cursor parameter for
get_matches - Add
ASCENDINGandDESCENDINGtoMatchSortto make it more inuitive.OLDESTandNEWESTstill exist there for backwards compatibility, but are not listed in the documentation.
Bug fixes
- Fix rate limit handler for
AsynchronousClientwhen multiple asynchronous requests - Fix
UserAccountHistory.supporting_url
Other
- Update required version of
websocketsin requirements.txt from >=10.2,<11 to >=11,<12
v1.0.0
Unfortunately, I did not keep good track of all the small changes I made in this version, though I will make sure to keep better track in the future. Most of the changes here will be rather vague.
- Several of the changes in this update are related to making the library more user friendly and providing quality of life features:
- Everything in the library has been properly typed.
- Previously undocumented objects have been documented.
- Each endpoint that would previously return a dictionary returns a unique object that is documented and typed. However, they are also backwards compatible and will still work when indexed like dictionaries.
- Some examples have been updated to be more informative and a couple more have been added.
- Much documentation has been fixed to be up to professional standards and there should be barely any mistakes in documentation.
- The formatting of the code has been standardized using black, which is being used in tandem with flake8.
- Tests have been updated to account for all the new changes and some of them have been improved to better ensure functions are working correctly.
- Several endpoints have been fixed so that they work correctly.
Regarding breaking changes: there are some, but since I didn't keep track of all the changes I made, it'd be very time consuming to pin point and list all of them. Sorry for the inconvenience.