drewcm / remi

A simple push notification reminder microservice.

Remi

A containerized reminder microservice. Reminders can be set up at the command line or via http://pushbullet.com. Remi sends the reminder notifications via PushBullet. Remi is useful for setting quick reminders that can be received on both mobile or non-mobile devices.

Remi is built using Python, Flask, RabbitMQ, SQLite, and Docker.

Example Usage

The examples below will all set reminders. The syntax for setting reminders is identical on the command line and via the PushBullet web interface.

reminder 4h OPTIONAL_MESSAGE
reminder 1d4hr30m OPTIONAL_MESSAGE
reminder tomorrow OPTIONAL_MESSAGE
reminder 7pm OPTIONAL_MESSAGE
reminder 12:30am OPTIONAL_MESSAGE

Reminder Confirmation

When a reminder is successfully set, the output will look like the following.

Your reminder will be sent tomorrow at 9:00 AM

Deployment

Deploying remi involves setting $ENV_FILE and running docker-compose:

export ENV_FILE=$PWD/remi.env && docker-compose up

Below is the structure of $ENV_FILE:

REMI_CONFIG=/config.json
FLASK_SECRET_KEY=[SET ME]
PUSHBULLET_API_TOKEN=[SET ME]
REST_API_TOKEN=[SET ME]
RABBITMQ_DEFAULT_USER=[SET ME]
RABBITMQ_DEFAULT_PASS=[SET ME]

Documentation for getting a PUSHBULLET_API_TOKEN is here. REST_API_TOKEN is set by you. You can use command line tools like gpg or openssl to generate a unique API token.

Author

• Andrew C. Martin - drewcm

License

This project is licensed under the MIT License - see the LICENSE.md file for details