Skip to content

v3.0.0

Choose a tag to compare

@Liam-DeVoe Liam-DeVoe released this 01 Feb 05:39
· 384 commits to master since this release

This is a breaking release. See below for how to migrate (all changes are pretty simple)

the only non-breaking change in this release: ossapi now has online documentation! https://circleguard.github.io/ossapi/

OssapiV2 has been renamed to Ossapi, and Ossapi has been renamed to OssapiV1. You'll need to adjust imports accordingly depending on if you were using api v1 (previously Ossapi, now OssapiV1) or api v2 (previously OssapiV2, now Ossapi).

several type_ parameters have been renamed to type:

  • OssapiV2#ranking type_ param renamed to type
  • OssapiV2#user_scores type_ param renamed to type
  • OssapiV2#user_beatmaps type_ param renamed to type
  • OssapiV2#beatmap_scores type_ param renamed to type

several functions and attributes have been renamed:

  • OssapiV2#changelog_lookup removed, use OssapiV2#changelog_build_lookup instead
  • OssapiV2#create_pm removed, use OssapiV2#send_pm instead
  • GameMode.CTB removed, use GameMode.CATCH instead
  • GameMode.STD removed, use GameMode.OSU instead

Many arguments in OssapiV2 methods have been made keyword-only. This shouldn't affect many programs, but there may be the occasional case where you need to update to a keyword argument.

eg:

# before
api.beatmap_user_score(221777, 12092800, GameMode.OSU)

# after
api.beatmap_user_score(221777, 12092800, mode=GameMode.OSU)