⛅ Weather Status Widget for GitHub

A silly program to update your GitHub user's profile status with the current weather:

The program retrieves data from OpenWeather API. It requires API key, that can be obtained for free, following OpenWeather API documentation.

To update user's status on GitHub, the program uses GitHub's GraphQL API and requires API token with user scope.

Usage

• Add your desired values for following parameters:
  • Expiration Time of the new status in minutes (default 30 min, maximum 255 min)
  • GitHub Token
  • OpenWeather API Key
  • Query location (default Berlin,De)
• Compile and run the application with following commands:

$ go build -o github-weather .
$ ./github-weather

github-weather -help will print the list of all available options.

Run the program as cronjob

*/10 * * * * github-weather [params] 2>> github-weather.log

See example of a crontab file in the project's misc directory.

Run the program on Kubernetes

Refer to deployments/README.md.

License

MIT