https://github.com/jdblack/sotd
A song of the day bot written in go for slack
https://github.com/jdblack/sotd
bot golang slack sqlite sqlite3
Last synced: 5 months ago
JSON representation
A song of the day bot written in go for slack
- Host: GitHub
- URL: https://github.com/jdblack/sotd
- Owner: jdblack
- License: bsd-3-clause
- Created: 2022-06-24T06:17:36.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-03-07T16:03:17.000Z (over 3 years ago)
- Last Synced: 2025-10-11T21:49:21.546Z (8 months ago)
- Topics: bot, golang, slack, sqlite, sqlite3
- Language: Go
- Homepage:
- Size: 158 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: Changelog.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Song of the day bot
This project is a Song of the Day Slack Bot that provides daily link from a
list of songs to one or more channels. The bot provides a separate
playlist for each channel. Channels that run out of their private list of
songs will backfill from songs that have been previously played in other
channels.
The playlist for each channel is randomized, allowing users to add many of
their favorite songs at one time without hogging the front of the playlist
queue. Prolific users are able to swamp out other users, so it's
advisable to encourage many users to participate!
## Usage
Interation with the bot primarily happens via private message. You can send
the following commands to the bot to control song of the day for your channel
### Bot commands
-------------------
This bot only listens for private messaages for security purposes. There is
also no need to invite Sotd into any channels for it to work, as it can
post blindly into channels.
**add CHANNEL URL [OPTIONAL DESCRIPTION]** - Add a song to a play with optional
description
**delete URL** - Delete song matching URL
**playlists** - List all running playlists
**load CHANNEL PATH|URL** - Import a json playlist from an URL. Imports will be
credited to the importer (See Bulk Importing Songs, below)
**stop CHANNEL** - Tell SOTD to remove a playlist for a channel. The songs will be
saved for backfill, but the playlist will be gone, gone, gone
**show CHANNEL** - Show the playlist for a given channel
**hello** - Say hello
## Crontab
Each channel can be scheduled independently of one another. The pattern is a
stanadrd cron format (https://en.wikipedia.org/wiki/Cron) with numeric fields
for Minute, Hour, Day of Month, Month and Day of week (numeric, sunday being 0)
` 00 22 * * 1-5 ` - Play a song at 22:00 UTC (3PM PDT) Mon-Fri to celebrate the deployment window
` 00 16 * * 1 ` - Play a monday morning song every Monday for the SRE Livesite channel
The main intent is for each channel to set the best time for SOTD for their own
channel playlist, but the functiality is there if you want to set your cron up
for certain months or days of the month too.
## Bulk Importing Songs
Songs can be imported over HTTP/S via a json formatted list. The list should have
the following structure:
```
[
{
"URL": "https://www.youtube.com/watch?v=hQKfAdhXBpA"
"Description": "Kids playing drums in new orleans"
},
{
"URL": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
"Description": "Would I be me without this one?"
},
]
```
You can instruct the bot to import the bot to import this list to the playlist of your choice
by messaging it `load #your_channel_name https://some.url/here.json`. Imported songs will
be credited to you, so I'd suggest being thoughtful about introducting NSFW songs in your
work environment.
## Installation
Sotd is able source its configuration from either Ini files or environment variables, depending upon
whether the deployment is intended for traditional installs or docker. Any configuration value specified
in the ini config may be set via the environment by setting a key of `SOTD_$section_$key="value"`. For
example, one can turn on event streaming by running export `SOTD_slack_debug=true`
```
[slack]
# debug = anything # Setting debug to any value will turn it on
botToken=xoxb-#############-#############-########################
appToken=xapp-#-###########-#############-################################################################
```
### Docker Installation
As mentioned, sotd can be deployed as a container as well, by setting envrionment variables. For example,
this will set up an ephemeral sotd bot
```
# An example
# cat > envfile <bot
bot-- FromBot
channel --> controller
controller-- funcs -->jukebox
controller-- ToBot
channel -->bot
controller-- funcs -->bot
jukebox --> cron{Cron Scheduler}
cron{Cron Scheduler}-- Playset
channel -->controller
```
## Dedication
This project is dedicated to my close friends Belmin, Brandon, Brian, Drew,
Jaysen, Jeff, Jeremy and Jhurani. You guys mean the world to me and I
literally can not wait for the day for our paths to cross again. Come
see me =)