Quotelogger is a simple python program to passively log user quotes from Twitch bots such as StreamElements
- Passively logs quotes from IRC with no authentication necessary
- Easy configuration
- Quotes saved in SQLite3
- No external Python depencies!
Extended by qsearch, which helps you manage the database by:
- Searching quotes by content or number
- Exporting the database to a CSV file
- Finding missing quotes
- Estimating completion
Installation can be done either by cloning the repository or downloading the latest release as a zip or tar.gz archive.
Python >= 3.9.x is supported, though feel free to experiment, older versions may work as well.
Unpack the included files in a suitable folder. Database will be initialized when the program is run for the first time.
Quotelogger requires four values in it's config.ini file
This is the default config.ini
[Settings]
# Filename for quote database (eg. quotes.db)
database = quotes.db
# Channel name (eg. twitch)
channel = twitch
# Quote bot name (eg. StreamElements)
quotebotname = streamelements
# Template for parsing messages (default is for StreamElements)
template = @<usr>, #<num>: <quote>
Things you need to change are the channel name and quotebotname if the chosen channel has a custom name for StreamElements (or is using a different bot altogether)
For bots other than StreamElements, you'll need to customize the template to suit the output of the bot.
Open up the your folder in the terminal and run:
python qlogger.py
Depending on your operating system, you might need to use python3 or py instead.
Press Ctrl + C to quit, as usual.
To use qsearch, run:
python qsearch.py - ARGUMENTS
Possible arguments for qsearch listed here:
| Short | Long | Explanation |
|---|---|---|
| -h | --help | Show help message |
| -n | --number | Search quotes by number |
| -c | --content | Search quotes by content |
| -s | --stats | Show statistics on saved quotes |
| -a | --all | Show all saved quotes in order |
| -e | --export | Export all saved quotes to a CSV file (Remember to include filename e.g Example.csv) |
| -m | --missing | Show which quotes are missing |
Very rarely the program stops logging new quotes, this issue is still under investigation and hard to replicate.
For now, if you plan on running this unsupervised I recommend restarting periodically. This should be easy to automate.
I consider the project feature-complete for now, so contributions are not necessarily expected.
Feel free to report any issues you encounter.
Beautiful logo created with Neo Cowsay