Skip to content
A Twitter bot to remember things or threads. [INACTIVE]
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_assets
postgres
streamer
tweeter
.gitignore
LICENSE
README.md
config_example.env
docker-compose.yml
oauth.py

README.md

slashRemindMe

A Twitter bot to remember things or threads.

Table of Contents

About

For example, someone tweets a playlist while you're in a meeting. Simply reply to the tread by tagging "@slashRemindMe" and a suitable time when you would like to be reminded. The reminder is sent as a tweet only to you.

Did a politician just make claims about future? @slashRemindMe a year "to check these claims" on the tweet, and see if they were right or not.

Think of @slashRemindMe as a "save for later" natively on Twitter. Here's some example uses.

Usage

Simply create a tweet in the format @slashRemindMe TIME OPTION "MESSAGE" (with quotes).

Time option and message order don't matter. They are also optional. Meaning if you can do a simple @slashRemindMe it will default to 1 day and a standard message. Everything before @slashRemindMe is not caught and everything after is.

The message will be shown in the reminder tweet.

Example usage

  • Good claims. I'll check them later. @slashRemindMe 4pm
  • @slashRemindMe 16 Jan 2016 "Pres debate happening"

Time Options

  • Bot tries to figure out your timezone. If it cannot, it defaults to UTC.
  • There are more options than stated here. Try to see if you can find more and I'll add them!
  • EOY means end of year
  • EOM means end of month
  • EOD means end of day
  • BOLDED TIMES INDICATE A SET IN STONE TIME (which can cause problems if you don't live in UTC)
  • It's better to use 10 minutes, 24 hours, 4pm on 1 dec etc than tomorrow/next week/next month because of above
Time Option New Time
@slashRemindMe One Year 2015-06-01 01:37:35 UTC
@slashRemindMe 3 Months 2014-09-01 01:37:35 UTC
@slashRemindMe One Week 2014-06-08 01:37:35 UTC
@slashRemindMe 1 Day 2014-06-02 01:37:35 UTC
@slashRemindMe 33 Hours 2014-06-02 10:37:35 UTC
@slashRemindMe 10 Minutes 2014-06-01 01:47:35 UTC
@slashRemindMe August 25th, 2014 2014-08-25 01:37:35 UTC
@slashRemindMe 25 Aug 2014 2014-08-25 01:37:35 UTC
@slashRemindMe 5pm August 25 2014-08-25 17:00:00 UTC
@slashRemindMe Next Saturday 2014-06-14 09:00:00 UTC
@slashRemindMe Tomorrow 2014-06-02 09:00:00 UTC
@slashRemindMe Next Thursday at 4pm 2014-06-12 16:00:00 UTC
@slashRemindMe Tonight 2014-06-01 21:00:00 UTC
@slashRemindMe at 4pm 2014-06-01 16:00:00 UTC
@slashRemindMe 2 Hours After Noon 2014-06-01 14:00:00 UTC
@slashRemindMe eoy 2014-12-31 09:00:00 UTC
@slashRemindMe eom 2014-06-30 09:00:00 UTC
@slashRemindMe eod 2014-06-01 17:00:00 UTC

FAQ

Why was the message off by a few minutes?

The bot currently goes to sleep every 2 minutes to save on resources. Meaning your message can be as late as 2 minutes + any connection issues it is having with Twitter.

Where is this bot running?

Currently I'm running this bot on a 1GB DigitalOcean instance (yes, that's an affiliate link. Use that to get a free VPS). The bot is not resource-intensive and uses a couple dozen MBs of RAM.

How do I see all my reminders?

That is currently not possible.

How do I delete/edit a reminder?

That is currently not possible.

Running

Requirements

Instructions

Create a file called config.env that looks like config_example.env. Fill in the necessary values.

For Twitter config:

  1. Register your app
  2. Get your app's key and secret.
  3. Create token and get the token and secret.

Then, to run the bot:

$ docker-compose up

Mac & Docker Machine

If you're using Docker Machine, follow these instructions for installation:

# Provision the docker engine
$ docker-machine create --driver virtualbox remindbot

# Set the environment
$ eval "$(docker-machine env remindbot)"

# See the IP address of the host
$ docker-machine ip remindbot

# Start the container
$ docker-compose up

License

Apache 2.0

Strongly inspired by the reddit bot.

You can’t perform that action at this time.