Skip to content

v1.1.0
Compare
Choose a tag to compare
@JamesMCo JamesMCo released this 17 Apr 16:23
· 26 commits to main since this release
v1.1.0
This tag was signed with the committer’s verified signature.
JamesMCo James C.
GPG key ID: B1B5CE18EE508FB2
Verified
Learn about vigilant mode.
fff8e36
This commit was signed with the committer’s verified signature.
JamesMCo James C.
GPG key ID: B1B5CE18EE508FB2
Verified
Learn about vigilant mode.

⚠️ Breaking Changes ⚠️

This release adds support for the newly announced MCC Island API. In doing so, it moves the previously existing Event API functionality to the mcc_api.event subpackage. To update your code, you an replace all from mcc_api import xyz lines with from mcc_api.event import xyz, with the exception of:

  • mcc_api.__version__ (the current version of the package)
  • mcc_api.__user_agent (the user agent used for requests to both APIs)

New Island functionality is introduced in the mcc_api.island subpackage. The MCC Island API uses GraphQL, and also requires an API key which can be minted using Noxcrew Gateway and used with mcc_api.island.set_api_key().

Changelog

  • Package split into two subpackages: mcc_api.event and mcc_api.island for querying the Event API and Island API respectively
    • Same Event functionality as before (get_event(), get_hall_of_fame(), get_participants(), and get_rundown())
    • New Island functionality, allowing GraphQL queries to be run against and returned from the new MCC Island API (see the README or docs for more details and a code example)
  • Documentation changes
    • Change theme to Sphinx's "bizstyle" theme
    • Move Event docs to /event, and add Island docs to /island
    • Add Island code example to README
    • Add badges to docs index page and README to show the currently targeted versions of the Event API and Island API
Assets 2
Loading