Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/asifpy/python-bdayreminder
Package to send birthday reminder from email, SMS and hangout
https://github.com/asifpy/python-bdayreminder
birthday-reminder jinja2 python python-bdayreminder reminder sqlalchemy
Last synced: 4 months ago
JSON representation
Package to send birthday reminder from email, SMS and hangout
- Host: GitHub
- URL: https://github.com/asifpy/python-bdayreminder
- Owner: asifpy
- Created: 2014-02-20T22:49:21.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2018-02-25T08:09:20.000Z (almost 7 years ago)
- Last Synced: 2023-08-14T18:26:37.373Z (over 1 year ago)
- Topics: birthday-reminder, jinja2, python, python-bdayreminder, reminder, sqlalchemy
- Language: Python
- Homepage:
- Size: 21.5 KB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Birthday Reminder
=================
This module helps to send birthday reminder to all DB members. Currently this module allows you to send reminder using email, sms and hangout messages.
Setup:
------
```shell
$ git clone https://github.com/asifpy/python-bdayreminder
$ cd bdayreminder
```
Configuration
-------------
In-order to setup all the available services of this module, you need to update [config.ini](https://github.com/asifpy/python-bdayreminder/blob/master/bdayreminder/config.ini) with your GMAIL and WAY2SMS credentials.
Install Requirements
--------------------
```
- Create your seperate virtual env and activate it
- Install requirements: pip install -r requirements.txt
```
Usage
-----
```shell
$ python3 bdayreminder/manage.py --help
usage: Birthday Reminder [-h]
optional arguments:
-h, --help show this help message and exit
Choices supports the following:
syncdb - Creates new sqlite DB with person table
loadsampledata - Loads sample data from db/sample_data.py
loadexceldata - loads excel data from db/data/yourexcel.xlsx
runallreminders - Run reminder for email, sms and hangout
runemailreminder - Run reminder with only email
runsmsreminder - Run reminder with only sms
runhangoutreminder - Run reminder with only hangout message
```
Init DB
-------
Use the below command to create sqlite DB with `Person`.
```shell
$ python3 bdayreminder/manage.py syncdb
```
Load Sample Data
----------------
Update the `bdayreminder/db/loader.py` for your own sample data and then run the below command.
```shell
$ python3 bdayreminder/manage.py loadsampledata
```
Send Email Reminder
-------------------
Run the below command to send Email reminder
```shell
$ python3 bdayreminder/manage.py runemailreminder
```
Send Hangout Reminder
---------------------
Run the below command to send hangout reminder
```shell
$ python3 bdayreminder/manage.py runhangoutreminder
```
Send SMS Reminder
-----------------
Run the below command to send sms reminder
```shell
$ python3 bdayreminder/manage.py runsmsreminder
```
Send all reminders
------------------
Run the below script to send reminders using email, sms and hangout:
```shell
$ python3 bdayreminder/manage.py runallreminders
```