twilio implementation of the EHHOP-phone tree
This provides TwiML to a Twilio app. Phone tree greetings are in the assets directory. App is deployable to heroku.
To really run this thing you'll want the following resources in your infrastructure:
- Google OAuth 2.0
- A very special Google Spreadsheet
- Twilio
- Box
- sqllite
- redis
You can test the setup by calling the demo number set up at 862-242-5952.
6/21/16: See ehhapp-twilio/issues for up-to-date TODOs.
2/8/2016: Left TODOS:
- DEBUG all the things
- test for secure message delivery flow
- improve options to reach a live person (who to call? queue?)
- secure message delivery needs to have options for X hours instead of next day, call back every day at same time if not delivered
9/4/2015: All paths have been enabled but there may still be some bugs.
This was developed on a Debian 7 server using Python 2.7.11 packages. It is recommended that anyone contributing to this codebase use pyenv to manage different python versions. Until tests are written verifying compatability across different python versions, the .python-version file specifies which version this code is intended to run under.
Packages can and should be isolated from system site-packages in a virtualenv. Run virtualenv venv and then source venv/bin/activate before doing anything else.
We use the requirements.txt file to specify required packages. Run pip install -r requirements.txt to get what you need.
Test are currently written in full-blown unittest syntax. Our CI tool will run py.test tests.py. Why have we chosen pytest over nose? It "feels" better maintained.
We use Sphinx. To build the documentation, navigate into the docs directory, and run sphinx-build -b html _src _build where '_src' and '_build' are the source directory (where all the rst files are) and the build directory (where the html ends up) respectively.
If you have make, just make html.
Contribute! To automate make html whenever you contribute to the documentation, use the [entr][entr] utility.
ls -d _src/* | entr make html
It watches for changes to the _src/ directory, and automatically runs make html as files change.
To save you the headache of having to refresh the browser window you have open to the docs, you can also run in a different pane:
ls -d _build/html/*.html | entr reload-browser $BROWSER_OF_CHOICE
This sends a key-press to the browser and will refresh whatever the active tab is. This assumes the tab is open to wherever you are hosting the docs (usually localhost:8000 if you are using a Python's built-in SimpleHTTPServer).
To run it on localhost use:
python run.py