Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/leelow/catherine-labot

🤖 🌞 A tiny slack bot which gives you weather information.
https://github.com/leelow/catherine-labot

bot go natural-language slack slack-bot slackbot weather

Last synced: 10 days ago
JSON representation

🤖 🌞 A tiny slack bot which gives you weather information.

Host: GitHub
URL: https://github.com/leelow/catherine-labot
Owner: Leelow
License: mit
Created: 2017-07-04T22:28:38.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2017-07-04T22:30:02.000Z (over 7 years ago)
Last Synced: 2024-11-15T01:31:31.814Z (2 months ago)
Topics: bot, go, natural-language, slack, slack-bot, slackbot, weather
Language: Go
Homepage:
Size: 6.84 KB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: readme.md
- License: license

Awesome Lists containing this project

README

# catherine-labot

> A tiny slack bot which gives you weather information.

## Philosophy

`catherine-labot` is just a proof of concept to show how it can be easy to play with API to have a bot which is enough "clever" to understand natural langage and give you weather information (five days forecast due to the API limitation).
The name `catherine-labot` is just a tribute of the famous french weather presenter [Catherine Laborde](https://fr.wikipedia.org/wiki/Catherine_Laborde) retired in 2017, but don't worry she speaks english ;)

## Requirements

Please make sur Golang is installed correctly. The bot was tested on Golang 1.8.

## Config

The config file `config/config.json` contains api keys. You must edit it before running the bot.

```json
{
"slack_token": "SLACK_TOKEN",
"openweathermap_api_key": "OPENWEATHERMAP_API_KEY",
"meaningcloud_api_key": "MEANINGCLOUD_API_KEY"
}

```

The free plan of [OpenWeatherMap](https://openweathermap.org/) and [MeaningCloud](https://www.meaningcloud.com/) are enough to play and have fun discussing with the bot !

## Usage

After setting your bot in Slack, you can discuss with it mentioning it every time with `@`.
For instance :

@catherine-labot What is the weather at Rennes today at 5pm ?
> The estimated temperature at Rennes the 07/04 at 05 pm is 30°C. A clear sky is also planned.

@catherine-labot Is it raining next friday at Paris ?
> The estimated temperature at Paris the 07/07 is 24°C. A light rain is also planned.

@catherine-labot Do you like baguette ?
> Sorry, I don't understand, I am just a weather bot !

## Docker

A `Dockerfile` is present if you want to build `catherine-labot` and tun it as a Docker container.

## Credits

Thanks [@rapidloop](https://github.com/rapidloop) for the [slack library](https://github.com/rapidloop/mybot).

## License