Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pmonks/futbot
A Discord bot that delivers football (soccer) information to Discord.
https://github.com/pmonks/futbot
Last synced: 9 days ago
JSON representation
A Discord bot that delivers football (soccer) information to Discord.
- Host: GitHub
- URL: https://github.com/pmonks/futbot
- Owner: pmonks
- License: apache-2.0
- Created: 2020-06-18T16:22:34.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-12-22T20:02:57.000Z (11 months ago)
- Last Synced: 2024-10-15T15:18:40.263Z (21 days ago)
- Language: Clojure
- Size: 11.5 MB
- Stars: 4
- Watchers: 4
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
| | | |
|---:|:---:|:---:|
| [**main**](https://github.com/pmonks/futbot/tree/main) | [](https://github.com/pmonks/futbot/actions?query=workflow%3ACI+branch%3Amain) | [](https://github.com/pmonks/futbot/actions?query=workflow%3Adependencies+branch%3Amain) |
| [**dev**](https://github.com/pmonks/futbot/tree/dev) | [](https://github.com/pmonks/futbot/actions?query=workflow%3ACI+branch%3Adev) | [](https://github.com/pmonks/futbot/actions?query=workflow%3Adependencies+branch%3Adev) |
[](https://github.com/pmonks/futbot/issues)
[](https://github.com/pmonks/futbot/blob/main/LICENSE)
# futbot
A small [Discord](https://discord.com/) bot that provides football (soccer) competition information sourced from [football-data.org](https://www.football-data.org/), as well as posting new LotG quizzes posted by the [Dutch Referee Blog](https://www.dutchreferee.com/) and [CNRA](http://www.cnra.net/monthly-video-quizzes/), and videos posted by [a number of referee-focused YouTube channels](https://github.com/pmonks/futbot/blob/main/heroku-config.edn). This bot has been deployed to the [Referee Discord Server](https://invite.gg/referees), and was specifically designed and implemented for that community, and may therefore have limited utility elsewhere.
The bot also has a small, but growing number of ["responsive functions"](https://github.com/pmonks/futbot/milestone/2?closed=1) - command messages that it will respond to in any channels it has been added to.
Please review the [privacy policy](https://github.com/pmonks/futbot/blob/main/PRIVACY.md) before interacting with the deployed instance of the bot on the [Referee Discord Server](https://invite.gg/referees).
## Running Your Own Copy of the Bot
### Obtaining API Keys
Configure a Discord bot using the [Discord developer portal](https://discord.com/developers), obtaining an API key. Detailed instructions on this process are provided in the [`discljord` project](https://github.com/IGJoshua/discljord).
Obtain an API key for [football-data.org](https://football-data.org/).
Obtain a [Google API key](https://developers.google.com/youtube/registering_an_application).
### Running the Bot
Currently the bot is only distributed in source form, so regardless of how you intend to deploy it, you'll need to clone this repository locally.
#### Direct Execution
1. Either set environment variables as described in the default [`config.edn` file](https://github.com/pmonks/futbot/blob/main/resources/config.edn), or copy that file somewhere else and hardcode the values in the file directly.
2. If you set the environment variables in the previous step run `clj -T:run source`, otherwise run `clj -T:run source -c /path/to/your/config.edn`
Note that the `run` tool alias has other variations (e.g. to run the bot as an uberjar).
#### Dockerised Execution
Copy the default [`config.edn` file](https://github.com/pmonks/futbot/blob/main/resources/config.edn) to `./docker-config.edn`, and edit the entries in the file for your needs.
Build the container:
```
docker build -t futbot .
```
Run the container:
```
# Interactively:
docker run futbot
# In the background:
docker run -d futbot
```
#### Generating the IST Markov Chain
The [Markov chain](https://github.com/pmonks/futbot/blob/main/resources/ist-markov-chain.edn) containing the analysed [IST YouTube Channel's](https://www.youtube.com/channel/UCmzFaEBQlLmMTWS0IQ90tgA) video titles can be (re)generated by running:
```
clj -T:ist generate-markov :youtube-api-key "YOUR_GOOGLE_API_KEY"
```
Note that this command has the side effect of dropping a `titles-YYYY-MM-DD.edn` file in the current directory the first time it's run each day. This is a workaround for YouTube's draconian API call quotas. Deleting or renaming the file will force the code to call the YouTube APIs again (which may then fail, due to those quotas...).
## Contributor Information
[Contributing Guidelines](https://github.com/pmonks/futbot/blob/main/.github/CONTRIBUTING.md)
[Bug Tracker](https://github.com/pmonks/futbot/issues)
[Code of Conduct](https://github.com/pmonks/futbot/blob/main/.github/CODE_OF_CONDUCT.md)
### Developer Tools
`futbot` uses [tools.build](https://clojure.org/guides/tools_build) for development-time automation. The full list of available build tasks can be obtained by running:
```shell
$ clojure -A:deps -T:build help/doc
```
### Developer Workflow
This project uses the [git-flow branching strategy](https://nvie.com/posts/a-successful-git-branching-model/), with the caveat that the permanent branches are called `main` and `dev`, and any changes to the `main` branch are considered a release and auto-deployed (push to Heroku).
For this reason, **all development must occur either in branch `dev`, or (preferably) in temporary branches off of `dev`.** All PRs from forked repos must also be submitted against `dev`; the `main` branch is **only** updated from `dev` via PRs created by the core development team. All other changes submitted to `main` will be rejected.
## License
Copyright © 2020 Peter Monks
Distributed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
SPDX-License-Identifier: [Apache-2.0](https://spdx.org/licenses/Apache-2.0)