Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/compufox/remindmebot
a little ruby bot for setting up reminders for users on mastodon
https://github.com/compufox/remindmebot
bot mastodon
Last synced: 2 months ago
JSON representation
a little ruby bot for setting up reminders for users on mastodon
- Host: GitHub
- URL: https://github.com/compufox/remindmebot
- Owner: compufox
- Created: 2017-10-22T17:48:10.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-12-18T07:36:56.000Z (about 6 years ago)
- Last Synced: 2024-04-13T12:53:08.086Z (8 months ago)
- Topics: bot, mastodon
- Language: Ruby
- Size: 53.7 KB
- Stars: 9
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# RemindMeBot
This is a complete reworking of the original RemindMe bot I made using python (hosted over [here](https://botsin.space/@RemindMe))
I feel like this bot will be better able to parse messages and scheduling replies
Feel free to contribute if you want!
# Running personal version
You'll need to set your database settings in `db.yml`. Examples are provided for MySQL and SQLite configs (`db.ex_mysql.yml` and `db.ex_sqlite.yml`, respectively). For a bare bones SQLite setup do this:
```bash
cp db.ex_sqlite.yml db.yml
```
When running the bot you need to specify an instance and provide a mastodon access token on the command line
Something like:
```bash
TOKEN='your_access_token_here' INSTANCE='https://your_cool_instan.ce' bundle exec ruby main.rb
```
## Features
- scheduling reminders (see Time Input Specifications below)
- canceling reminders that have yet to go off
- saving/restoring to a (MySQL/MariaDB/SQLite) database
## Time input specifications
As of right now the bot is only able to parse times that come in certain formats:
- HH:MM:SS PM TZD (seconds field is optional, as are minutes. AM/PM is needed if specifiying 12 hour time)
- N seconds (or days/hours/weeks/minutes)
To make the status to the bot feel more like natural language you can also supply something like:
- in N seconds
- at HH:MM TZD
it will still parse out to the correct time
## TODO
- command to repeat a reminder
- newlines not returned properly in reminder status?
- make bot less spammy with !help message