WeatherBot

A Discord application to fetch OpenWeather data.

Welcome to WeatherBot!

A succinctly written discord application to satisfy in-chat weather reports and forecasts.

Clone it, supply credentials, run it!

Table of Contents 📖

---

• Get Started
• Usage
• Technologies
• Contribute
• Acknowledgements
• License/Stats/Author

Get Started 🚀

---

Fetch dependencies:

pip install -r requirements.txt

Create config.yml in the repo's root, and populate as follows:

# Discord
app_id: # developer console
public_key: # developer console
perms_int: # developer console
token: # developer console
client_id: # developer console
client_secret: # developer console
guild_id: # server settings in discord
#
channel_scope:
  - channel-name
  - other-channel-name


# OpenWeather
open_weather_key: # openweather console
latitude: # google maps
longitude: # google maps

You can ensure your bot token is active or generate a new one here.

See the Discord.py API docs to implement new features.

Usage ⚙

---

Run indefinitely:

./main.py

Info message:

./main.py --help

Chat commands (presuming you name your application WeatherBot):

# get current climate conditions
/WeatherBot current

# get 5-day climate forecast
/WeatherBot forecast

# get current air quality metrics
/WeatherBot airquality

Technologies 🧰

---

• Discord.py
• PyYaml
• Typer
• OpenWeather

Contribute 🤝

---

If you think you have a cool weather data idea, submit a PR 🤓

Acknowledgements 💙

---

Thanks to Jean Choi, my partner, for being so supportive all the time.

License, Stats, Author 📜

---

See License for the full license text.

This repository was authored by Isaac Yep.

Back to Table of Contents