This project will take a location, look up coordinates using nominatim, then scrape weather.gov with those coordinates to produce a weather forecast.
- Nominatim does not want more than 1 request/second. See their usage policy. Be advised.
- Not all location formats are guaranteed to work. Zip codes are a prime example - there's no mechanism built in to get them to only return US codes... yet
- Other rough edges are sure to exist, but there's very little damage you can do (outside of potentially getting throttled to hell by exceeding the rate limit)
The CLI tool is for testing either with static pages or with provided locations
pipenv run cli.py --location "baltimore,md"
... # long forecast in JSON-ese
pipenv run cli.py --static-path ./test/sample.html
... # another long JSON forecast
The API allows retrieving an atom feed of the current forecast for a given location. Add the following to any reader that can parse atom and sweet feedreading goodness should ensue:
<stibbons.url>/rss?location=<valid location in the US>
See above disclaimer about location parsing still being a little janky.
Example usage in hometown, usa, with stibbons hosted on stibbons.example.com:
https://stibbons.example.com/rss?location=hometown,us
The original protocol was rss, hence the endpoint mismatch with the current atom feed. This will be fixed eventually.
The feed will always contain one post: the most recently published forecast. Every time the endpoint is called, it will do the following:
- Scrape a new forecast from weather.gov (this will not scale, be wary, more caching needs to be added)
- Determine if the previously published forecast is expired based on whether the 'last updated' info on the new forecast is different from what's in the previously published one
- If the forecast is new, it is published instead of what was published previously - old forecasts are discarded
- If the hazardous conditions advisories have changed since the last forecast, appropriate language highlighting this is added to the forecast
- If nothing has changed, the previous feed is returned with no modifications.