{"id":18780368,"url":"https://github.com/karan/slashremindme","last_synced_at":"2025-04-13T11:30:50.058Z","repository":{"id":65984368,"uuid":"46881126","full_name":"karan/slashRemindMe","owner":"karan","description":"A Twitter bot to remember things or threads. [INACTIVE]","archived":false,"fork":false,"pushed_at":"2015-11-30T14:58:28.000Z","size":138,"stargazers_count":14,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-04T23:29:50.552Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://twitter.com/slashRemindMe","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/karan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-11-25T19:08:33.000Z","updated_at":"2023-09-08T17:04:01.000Z","dependencies_parsed_at":"2023-02-19T18:15:56.855Z","dependency_job_id":null,"html_url":"https://github.com/karan/slashRemindMe","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/karan%2FslashRemindMe","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/karan%2FslashRemindMe/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/karan%2FslashRemindMe/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/karan%2FslashRemindMe/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/karan","download_url":"https://codeload.github.com/karan/slashRemindMe/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248705503,"owners_count":21148549,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-07T20:26:07.356Z","updated_at":"2025-04-13T11:30:49.482Z","avatar_url":"https://github.com/karan.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# slashRemindMe\n\n[![](http://i.imgur.com/o6bepoH.png?1)](https://twitter.com/slashRemindMe)\n\nA Twitter bot to remember things or threads.\n\n## Table of Contents\n\n* [About](#about)\n* [Usage](#usage)\n  * [Example Usage](#example-usage)\n* [Time Options](#time-options)\n* [FAQ](#faq)\n  * [Why was the message off by a few minutes?](#why-was-the-message-off-by-a-few-minutes)\n  * [Where is this bot running?](#where-is-this-bot-running)\n  * [How do I see all my reminders?](#how-do-i-see-all-my-reminders)\n  * [How do I delete/edit a reminder?](#how-do-i-deleteedit-a-reminder)\n* [Running](#running)\n* [License](#license)\n\n## About\n\nFor 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.\n\nDid 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.\n\nThink of @slashRemindMe as a \"save for later\" natively on Twitter. Here's some [example uses](#example-usage).\n\n## Usage\n\nSimply create a tweet in the format `@slashRemindMe TIME OPTION \"MESSAGE\" (with quotes)`.\n\n[Time option](#time-options) 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.\n\nThe message will be shown in the reminder tweet.\n\n### Example usage\n\n* `Good claims. I'll check them later. @slashRemindMe 4pm`\n* `@slashRemindMe 16 Jan 2016 \"Pres debate happening\"`\n\n## Time Options\n\n* Bot tries to figure out your timezone. If it cannot, it defaults to UTC.\n* There are more options than stated here. Try to see if you can find more and I'll add them!\n* EOY means end of year\n* EOM means end of month\n* EOD means end of day\n* **BOLDED TIMES INDICATE A SET IN STONE TIME (which can cause problems if you don't live in UTC)**\n* **It's better to use `10 minutes`, `24 hours`, `4pm on 1 dec` etc than tomorrow/next week/next month because of above**\n\nTime Option | New Time\n---------|----------\n@slashRemindMe One Year | 2015-06-01 01:37:35 UTC\n@slashRemindMe 3 Months | 2014-09-01 01:37:35 UTC\n@slashRemindMe One Week | 2014-06-08 01:37:35 UTC\n@slashRemindMe 1 Day | 2014-06-02 01:37:35 UTC\n@slashRemindMe 33 Hours | 2014-06-02 10:37:35 UTC\n@slashRemindMe 10 Minutes | 2014-06-01 01:47:35 UTC\n@slashRemindMe August 25th, 2014 | 2014-08-25 01:37:35 UTC\n@slashRemindMe 25 Aug 2014 | 2014-08-25 01:37:35 UTC\n@slashRemindMe 5pm August 25 | **2014-08-25 17:00:00 UTC**\n@slashRemindMe Next Saturday | **2014-06-14 09:00:00 UTC**\n@slashRemindMe Tomorrow | **2014-06-02 09:00:00 UTC**\n@slashRemindMe Next Thursday at 4pm | **2014-06-12 16:00:00 UTC**\n@slashRemindMe Tonight | **2014-06-01 21:00:00 UTC**\n@slashRemindMe at 4pm | **2014-06-01 16:00:00 UTC**\n@slashRemindMe 2 Hours After Noon | **2014-06-01 14:00:00 UTC**\n@slashRemindMe eoy | **2014-12-31 09:00:00 UTC**\n@slashRemindMe eom | **2014-06-30 09:00:00 UTC**\n@slashRemindMe eod | **2014-06-01 17:00:00 UTC**\n\n## FAQ\n\n#### Why was the message off by a few minutes?\n\nThe 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.\n\n#### Where is this bot running?\n\nCurrently I'm running this bot on a 1GB [DigitalOcean](https://www.digitalocean.com/?refcode=422889a8186d) 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.\n\n#### How do I see all my reminders?\n\nThat is currently not possible.\n\n#### How do I delete/edit a reminder?\n\nThat is currently not possible.\n\n## Running\n\n#### Requirements\n\n- [Docker](https://docs.docker.com/installation/)\n- [Docker Compose](https://docs.docker.com/compose/install/)\n- [Docker Machine](https://docs.docker.com/machine/install-machine/) (Mac OS X)\n\n#### Instructions\n\nCreate a file called `config.env` that looks like `config_example.env`. Fill in the necessary values.\n\nFor Twitter config:\n\n1. Register your app\n2. Get your app's key and secret.\n3. Create token and get the token and secret.\n\nThen, to run the bot:\n\n```bash\n$ docker-compose up\n```\n\n#### Mac \u0026 Docker Machine\n\nIf you're using Docker Machine, follow these instructions for installation:\n\n```bash\n# Provision the docker engine\n$ docker-machine create --driver virtualbox remindbot\n\n# Set the environment\n$ eval \"$(docker-machine env remindbot)\"\n\n# See the IP address of the host\n$ docker-machine ip remindbot\n\n# Start the container\n$ docker-compose up\n```\n\n## License\n\nApache 2.0\n\nStrongly inspired by the [reddit bot](https://www.reddit.com/r/RemindMeBot/comments/24duzp/remindmebot_info/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkaran%2Fslashremindme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkaran%2Fslashremindme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkaran%2Fslashremindme/lists"}