Skip to content

praekeltfoundation/reminder-scheduler

Repository files navigation

Reminder Scheduler

Build Passing/Failing on TravisCI.com Code Style: Black Code Coverage Docker Automated build

The Reminder Scheduler is a Django application for scheduling reminder messages that need to be sent at a later date. Currently messages are sent over WhatsApp via Turn. The reminder and scheduled date is stored in a database and a background task checks regularly for any messages due to be sent.

Usage

Local installation

To set up and run reminder-scheduler locally, do the following:

$ git clone git@github.com:praekeltfoundation/reminder-scheduler.git
$ cd reminder-scheduler
$ virtualenv ve
$ source ve/bin/activate
$ pip install -e .
$ pip install -r requirements-dev.txt

Tools

  • PostgreSQL
  • Redis
  • black - this repository uses an opinionated python code formatter. See pyproject.toml for config.

Contributing

See our ways of working for a guide on how to contribute to reminder-scheduler.

Deprecation

The following endpoints of reminder-scheduler will be deprecated: - scheduler/ - ''