Skip to main content

A working re-implementation of the weather module for Sopel

Project description

version build issues alerts coverage-status license

Introduction

sopel-weather is a weather lookup plugin for Sopel.

Since Yahoo deprecated their weather API on January 3, 2019, a reimplementation of the weather plugin was necessary

Installing

If possible, use pip to install this plugin. Below are example commands; you might need to add sudo and/or call a different pip (e.g. pip3) depending on your system and environment. Do not use setup.py install; Sopel won’t be able to load the plugin correctly.

Published release

pip install sopel-modules.weather

From source

Clone the repo, then run this in /path/to/sopel-weather

pip install .

Configuring

You can automatically configure this plugin using the sopel configure –plugins command.

However, if you want or need to configure this plugin manually, you will need to define the following in ~/.sopel/default.cfg

[weather]
geocoords_provider = GEOCOORDS_PROVIDER
geocoords_api_key = GEOCOORDS_API_KEY
weather_provider = WEATHER_PROVIDER
weather_api_key = WEATHER_API_KEY

Usage

Current Weather

.weather # Only works if setlocation has been previously run
.weather seattle, us
.weather london
Paris, Ile-de-France, FR: 6°C (42°F), Clear, Humidity: 83%, UV Index: 0, Gentle breeze 4.0m/s (↗)

24h Forecast

.forecast # Only works if setlocation has been previously run
.forecast seattle, us
.forecast london
Forecast: Paris, Ile-de-France, FR: Light rain tomorrow through next Saturday, High: 15°C (59°F), Low: 11°C (52°F), UV Index: 2

Customize User Location

.setlocation london # Sets location by city name
.setlocation 98101 # Sets location by US zip code
I now have you at Paris, Ile-de-France, FR

Requirements

Modern weather APIs require Latitude & Longitude as inputs to their APIs, so we need to leverage a GeoCoords API to convert location searches to coordinates.

API Keys

GeoCoords

LocationIQ

https://locationiq.com/

Weather

Open-Meteo

Does not require an API key; use any string you want.

https://open-meteo.com/

OpenWeatherMap

https://openweathermap.org/

Pirate Weather

A drop-in replacement API for the old Dark Sky service bought by Apple.

https://pirateweather.net/

Python Requirements

requests
sopel

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sopel_modules.weather-1.6.1.tar.gz (13.5 kB view details)

Uploaded Source

Built Distribution

sopel_modules.weather-1.6.1-py3-none-any.whl (12.0 kB view details)

Uploaded Python 3

File details

Details for the file sopel_modules.weather-1.6.1.tar.gz.

File metadata

  • Download URL: sopel_modules.weather-1.6.1.tar.gz
  • Upload date:
  • Size: 13.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for sopel_modules.weather-1.6.1.tar.gz
Algorithm Hash digest
SHA256 3e569edf73b3ba457aad8c910483ab2a53d4e715245e860b260fb2fdcc5946fa
MD5 508b513ff5e84c448ba58f973bed404f
BLAKE2b-256 e891f2b29ddb082582ddd6e963630215b3fe57fe2d59f22b42fc74d76ef87e99

See more details on using hashes here.

File details

Details for the file sopel_modules.weather-1.6.1-py3-none-any.whl.

File metadata

File hashes

Hashes for sopel_modules.weather-1.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ac33ceb092eb46340a5842ced6454a8fe60c7a769e2ef48bf2e984adeee69aec
MD5 4af1837bac1dea4d4b4b5684490e8e36
BLAKE2b-256 74ebb8201b70567b19b1c3de13fbdd4129e653264249256e1892b3abec54b8f5

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page