Skip to content
Automatic updates for KGP T&P make murderous rage slightly pleasant.
Branch: master
Clone or download
Latest commit 3e5c1a4 Aug 26, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.env-template Adds template file for environment variables Jul 12, 2018
.gitignore
LICENSE Create LICENSE Nov 23, 2017
Pipfile Catch error better, implement Pipfile standard Aug 11, 2018
Pipfile.lock Catch error better, implement Pipfile standard Aug 11, 2018
Procfile Bugfixes Nov 28, 2015
README.md Adds template file for environment variables Jul 12, 2018
app.json Use mailgun in app.json Dec 6, 2015
erp.py
hooks.py PDF Bug - The Sequel (#21) Aug 11, 2018
main.py
requirements.txt Fix typo in requirements file Aug 4, 2016
runtime.txt Explicitly specify python runtime Nov 23, 2017
settings.py Add settings.py for dotenv setup Aug 3, 2016
update.py one less key check Aug 26, 2018

README.md

mftp

Deploy

Get emails when T&P stuff changes on IIT KGP's ERP.

Setup

Deploy to Heroku and set config variables.

Required config variables

The following is a list of all the config variables that are required for MFTP to work:

EMAIL_ADDRESS
ERP_A1
ERP_A2
ERP_A3
ERP_PASSWORD
ERP_Q1
ERP_Q2
ERP_Q3
ERP_USERNAME
MAILGUN_API_KEY
MAILGUN_DOMAIN
MAILGUN_PUBLIC_KEY
MAILGUN_SMTP_LOGIN
MAILGUN_SMTP_PASSWORD
MAILGUN_SMTP_PORT
MAILGUN_SMTP_SERVER
MONGODB_URI
NOTICES_EMAIL_ADDRESS

Among these, the variables prefixed by MAILGUN will be added by Heroku when you run the command heroku addons:create mailgun:starter.

The MONGODB_URI env variable will be set by heroku addons:create mongolab:sandbox.

You need to add the other variables. You can add either by using the command heroku config:set KEY=VALUE from the command line, or you can use the Heroku web interface, under the Settings tab.

Testing on local system

  1. Make a copy of the .env-template file and rename it to .env in the root directory.

cp ./.env-template ./.env

  1. Add values of all the variables in the newly created .env file accordingly. (Descriptions of all the varibales can be found in app.json). Note : app.json does not contain DEBUG variable as it explicitly configures scripts to run in local environment friendly way.

  2. Install all the python modules from the requirements file. Note : The program runs on Python 2

pip install -r requirements.txt

  1. Run settings.py to load variables from .env file to the local environment.

python settings.py

  1. Now run the main tornado server.

python main.py

WTF

mftp monitors your ERP account for changes to the notices and the companies list, and sends you an email if there are any new or modified entries. Your credentials are stored as Heroku config variables, and you run your own Heroku instance.

License

GPLv3. Issues and pull requests are welcome.

You can’t perform that action at this time.