Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/s3cur3/okay_weather
The okayest live-ish weather library you'll ever see
https://github.com/s3cur3/okay_weather
Last synced: about 1 month ago
JSON representation
The okayest live-ish weather library you'll ever see
- Host: GitHub
- URL: https://github.com/s3cur3/okay_weather
- Owner: s3cur3
- License: mit
- Created: 2023-07-19T00:32:03.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-02T14:31:14.000Z (about 1 year ago)
- Last Synced: 2023-10-02T18:54:19.124Z (about 1 year ago)
- Language: Elixir
- Homepage:
- Size: 1.03 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/s3cur3/okay_weather/actions/workflows/elixir-build-and-test.yml) [](https://github.com/s3cur3/okay_weather/actions/workflows/elixir-dialyzer.yml) [](https://github.com/s3cur3/okay_weather/actions/workflows/elixir-quality-checks.yml) [](https://codecov.io/gh/s3cur3/okay_weather) [](https://www.gnu.org/licenses/gpl-3.0)
# okay_weather 🌦
**The okayest live-ish weather library you'll ever see.**
`OkayWeather` is an Elixir package for looking up the current weather in a particular location.
It will work by fetching METAR weather data from NOAA, parsing it, and providing a way to query it based on latitude and longitude or nearest airport.
Why it this just okay? A few reasons:
- The METAR data is *theoretically* updated hourly. In practice, the time between updates can stretch to 90 minutes or even longer, and the NOAA servers are not particularly reliable. We'll cache the most recent data we've seen, but especially for the first run on a fresh server, you're liable to get no data at all.
- The METAR data is coarse. If the location you're interested in is near a major airport, you're in luck. If not, what the METAR provides might be way off. (In the future, we could potentially do a linear interpolation of many weather stations in this case.)
Now, on the other hand, the thing that makes this library okay in a *positive* sense: it's free! Weather data can get expensive, especially at scale. NOAA's data is free, and if you can cache the results, you can get good enough data without breaking the bank.
**Warning**: okay_weather is pre-alpha right now. Please assume everything is broken.
## Installation
1. Add the package to your `mix.exs`:
```elixir
defp deps do
[
{:okay_weather, github: "s3cur3/okay_weather"},
]
end
```
2. Add `OkayWeather` to your `applications` list in `mix.exs`:
```elixir
def application do
[
extra_applications: [:logger, :okay_weather],
]
end
```
3. Add `OkayWeather` to your supervision tree in your `application.ex`:
```elixir
def start(_type, _args) do
children = [
OkayWeather.child_spec(),
]
...
end
```
4. Run `mix deps.get`