Migrate OpenWeaterMap to new library (support API 3.0)

[freekode]

Breaking change

Migration to new library with support of OneCall API (3.0).

OWM API v2.5 will be closed in June 2024. All OpenWeatherMap integrations must be migrated to mode (API) v3.0 to avoid service interruption.

Before the migration, you must have an active subscription (be aware that subscription activation takes up to 2h). After the subscription is activated, users can migrate integrations to mode v3.0 via repair notification or manually via the integration configuration menu.

The subscription has a free tier with 1000 calls/day. Consider setting the limit on the OpenWeatherMap website to stay under the threshold where API usage incurs a cost.

OpenWeatherMap official statement

Proposed change

Migrate new library pyopenweathermap I created specifically for Home Assistant. Currently, used pyowm library didn't have an update for a long time and seems dead.
Remove forecast modes, one call allows to retrieve daily and hourly forecasts. Remove migration from V1 to V2 of config_flow, forecast mode isn't used anymore, there is no need for migration.

New lib https://github.com/freekode/pyopenweathermap

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

• This PR fixes or closes issue:
  fixes APi 2.5 to be closed in June 2024 #115714
  fixes New API keys for OpenWeatherMap OneCall do not work with API 2.5  #113000
• This PR is related to issue:
• Link to documentation pull request: Update docs for OWM V3.0 home-assistant.io#32609

Checklist

• 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.

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

• Documentation added/updated for www.home-assistant.io

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.
• Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

• I have reviewed two other open pull requests in this repository.

[home-assistant]

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

Code owner commands

Code owners of openweathermap 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 openweathermap 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.

[bdraco]

I was hoping to be able to do another review pass on this before I'm flying all day tomorrow but it looks like the day got away from me. I'll be traveling for a week so I'll minimal time to look at this one. I'd like to try to get it merged before the 2024.6.x beta though given API 2.5 is going to go away.

[freekode]

I'm still traveling until Thursday, but I wanted to give you feedback on the issue so we can be sure to get it in before beta.

Thanks, have a nice trip :)

[frenck]

I've marked this PR, as changes are requested that need to be processed.
Please un-draft it once it is ready for review again by clicking the "Ready for review" button.

Thanks! 👍

../Frenck

Learn more about our pull request process.

[bdraco]

Almost there, but It looks like its always rejecting the API key now.

I also tried setting it up fresh with the same api key that is working with v2.5 and its rejecting it with the same error

[freekode]

yep, fixed

[bdraco]

Thanks @freekode

[bdraco]

Tested, everything working. Migration to 3.0 successful

[bdraco]

Please update the breaking change section to tell users what they need to do. The target audience for breaking changes is the user consuming the change. This will get published nearly verbatim in the release notes.

[freekode]

Added more info in PR description

[bdraco]

During subscription activation OpenWeatherMap asks for your credit card, but won't charge anything.

That implies that's a guarantee they won't be charged which we cannot make since OWM might change their policies.

Suggested reword:

OWM API v2.5 will be closed in June 2024. All OpenWeatherMap integrations must be migrated to mode (API) v3.0 to avoid service interruption.

Before the migration, you must have an active subscription (be aware that subscription activation takes up to 2h). After the subscription is activated, users can migrate integrations to mode v3.0 via repair notification or manually via the integration configuration menu.

The subscription has a free tier with 1000 calls/day. Consider setting the limit on the OpenWeatherMap website to stay under the threshold where API usage incurs a cost.