Skip to content

Conversation

@tr4nt0r
Copy link
Contributor

@tr4nt0r tr4nt0r commented Oct 31, 2025

Proposed change

The xbox-webapi library is pretty outdated and hasn't received any significant updates in 5 years, the only minor release in this time already being 2 years old. I tried to submit PRs to fix the most urgent issues but I haven't got any reaction nor do I expect one anytime soon. I decided to fork the library and not only did i fix the most urgent issues, I also completely modernized the code. It is now fully typed and uses modern typing syntax.

This fixes some things that were dysfunctional, because some data wasn't exposed by the API as the library used outdated endpoints or request headers.

There is also a change to 2 recently added sensors, following and follower, which don't include friends anymore, instead friend count will now have to be be added as a separate sensor.

Release notes of the new library:
https://github.com/tr4nt0r/python-xbox/releases/tag/v0.1.0

A diff between the old library and the new library:
tr4nt0r/python-xbox@v0.0.0...v0.1.0

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

Checklist

  • I understand the code I am submitting and can explain how it works.
  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.
  • Any generated code has been carefully reviewed for correctness and compliance with project standards.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.

To help with the load of incoming pull requests:

@home-assistant
Copy link

Hey there @hunterjm, mind taking a look at this pull request as it has been labeled with an integration (xbox) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of xbox can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign xbox Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants