search

sopel-irc / sopel-weather

A working re-implementation of the weather plugin for Sopel
MIT License
6 stars 7 forks source link

OpenWeatherMap API version 2.5 going away #52

Open dgw opened 7 months ago

dgw commented 7 months ago

OpenWeatherMap announced a turndown date (well, month) for their One Call API 2.5, meaning One Call API 3.0 will be the only version available after sometime in June 2024:

We would like to inform you about our plans to complete the migration from One Call API 2.5 to One Call API 3.0 that has started 2 years ago. In line with this, access to One Call API 2.5 will be finally closed in June 2024.

All One Call API 2.5 users are invited to the One Call API 3.0, which replicates the 2.5 version's functionality and includes several useful upgrades.

Unfortunately, the new API version does not fall under the same free subscription existing plugin users might have for the OWM provider. A separate Call By Call subscription is required with a free 1,000-call quota per day—and even a user intending to limit their apps to only the free quota must still provide personal & billing information to enable this newer endpoint.

For that reason I haven't yet tested the 3.0 endpoint against this plugin's existing provider code. (The existing provider probably will Just Work™ if updated to use the newer endpoint, according to comparisons in OWM's announcement linked above.)

IMO, the bigger change will be the importance of caching: 2.5 has a 60/min free request limit, vs. 3.0 allowing 1,000/day (equivalent to 0.694444/min, 2 orders of magnitude lower). Adding a cache to the OWM provider so it won't fetch results for the same location again within the 10-minute update window would be good, along with finally switching the plugin to entry-point style (started in #49) and switching from setup.cfg etc. to pyproject.toml.

All of the above combined with the upcoming release of Sopel 8.0 yield a very good breakpoint for stopping updates to the current sopel-modules.weather package and using a new name with a bumped major version. (I have already created a Pending Publisher on PyPI tied to this repo, planning ahead to convert .github/workflows/python-publish.yml. The new workflow style can be copied from elsewhere in the org, such as sopel-ipython.)

dgw commented 7 months ago

(The existing provider probably will Just Work™ if updated to use the newer endpoint, according to comparisons in OWM's announcement linked above.)

I got another email today (nag-tier frequency, if you ask me, given how long it is until the cutoff still) with this tidbit:

You don’t need to get new API keys, all your current API keys will work with One Call 3.0 after subscription.

That's good news for users who are willing to give OWM a credit card just to use the free daily quota. That isn't me, but hey. 😁

rubahness commented 7 months ago

I'm going to walk through the flow and I'll try to come back with my findings.

Some more details on the subscription:

One Call API 3.0 is included to the “One call by call” subscription plan only, users pay for the actual use of the product. There are no limits on the number of API calls, but you can set API calls limit per day in the "Billing plans" tab in your Personal account.

Please fill you billing information for subscription — One Call 3.0 API subscription, Base plan, 0.15 USD per 100 calls (VAT is not included) image

dgw commented 1 month ago

Reports coming in that OWM no longer works with the published version of sopel-weather.

There are alternative providers, of course, but this one needs to be fixed or removed.