Submission for Midterm Project

.gitignore

@@ -23,6 +23,7 @@ var/
 *.egg-info/
 .installed.cfg
 *.egg
+*.sqlite
 
 # PyInstaller
 #  Usually these files are written by a python script from a template

CHANGES.txt

@@ -0,0 +1,4 @@
+0.0
+---
+
+-  Initial version

MANIFEST.in

@@ -0,0 +1,2 @@
+include *.txt *.ini *.cfg *.rst
+recursive-include pylistener *.ico *.png *.css *.gif *.jpg *.jinja2 *.pt *.txt *.mak *.mako *.js *.html *.xml

Procfile

@@ -0,0 +1 @@
+web: ./run

README.md

@@ -1 +1,88 @@
-# CF401-Project-1---PyListener
+# PyListener
+
+PyListener is an application written on the Python Pyramid framework, designed to assist people with apraxia communicate with loved-ones and caretakers using a series of pictograms translated to text and shareable via email or sms.
+
+The purpose of this project was to create a visual communication tool in the form of a web-based app intended for use on mobile platforms to assist users with communication disabilities.
+Instances include users with a communication disability such as Apraxia, a motor disorder in which the patient is unable to perform certain tasks or movements despite full understanding and willingness. In [Apraxia of speech](https://en.wikipedia.org/wiki/Apraxia_of_speech), patients have difficulty conveying ideas and thoughts from the brain to the spoken words. Apraxia of speech can manifest itself after incidents such as a stroke or trauma or be present in early infancy (Childhood Apraxia of Speech).
+
+
+# How it works
+
+A caregiver can register with a username, password, email, phone number and a profile picture. The caregiver is also prompted to enter the user's name.
+Once registered, the caregiver becomes the primary contact for the user and a pictogram is created in the address book.
+
+The account is immediately logged in and taken to the configuration page.
+There, the caregiver can add or delete pictograms for contacts, categories and/or attributes. Fill the form with an image file, label, description (which will be used to build the sentence) and upload your customized pictogram.
+Once done, simply click on the home button and you are ready to go!
+
+The app comes with pre-loaded pictograms so any user can create an account and start building sentences right away.
+
+The first screen for the user is the Address Book. There, the user can pick whom they wish to talk to. Once selected, it takes you to the second screen: Categories. There, the user can select the subject of the sentence. Which takes you to the third screen: Attributes. Attributes are always related to the category selected.
+
+Once the sentence fully built, the user is taken to the fourth and final screen: Display.
+The sentence will be, indeed, displayed and the user is offered three choices:
+Send an SMS, send an Email or start over.
+
+If the user picks SMS or Email, a message will immediately be sent to the contact selected at the begining of the sentence. If the user chooses to start over, they will be taken back to the first screen and can pick a new contact to talk to.
+
+# How we built it
+
+PyListener was created during our Code Fellows advanced python development midterm project by Ted Callahan, Maelle Vance and Rick Valenzuela. We had four days total to build the full application.
+
+We chose the Pyramid framework for its robustness. We are currently looking to rebuild the application using Django as we have plan to expand.
+
+We used Postgresql and sqlalchemy to build our database. The main challenge was to build all the relational databases as well as handling image uploads by users.
+
+To send sms and emails, we used two external apis: [Twilio](https://github.com/twilio/twilio-python) and [Yagmail](https://github.com/kootenpv/yagmail). We are very thankful for their extensive documentation!
+
+We deployed on Heroku: (http://pylistener.herokuapp.com/)
+
+# How to run it yourself
+
+Clone this repository into whatever directory you want to work from.
+
+```bash
+$ git clone https://github.com/PyListener/CF401-Project-1---PyListener.git
+```
+
+Assuming that you have access to Python 3 at the system level, start up a new virtual environment.
+
+```bash
+$ cd CF401-Project-1---PyListener
+$ python3 -m venv venv
+```
+
+Open `venv/bin/activate` in your editor and pass your own environment variable as following :
+- export DATABASE_URL= *your chosen database*
+- export TEST_DB= *your test database*
+- export EMAIL= *the gmail account you want to user to send emails from the app.*
+- export PASSWORD= *your gmail password*
+- export TWILIO_SID= *the twilio account sid you want to use to send emails from the app.*
+- export TWILIO_TOKEN= *your twilio token*
+- export TWILIO_NUMBER= *your twilio number in the following format: "+12345678910"*
+
+Then activate your environment:
+
+```bash
+$ source venv/bin/activate
+```
+
+Once your environment has been activated, make sure to install the requirements:
+
+```bash
+(venv) $ pip install -e .
+```
+
+You are then ready to initialize your database and run the app!
+
+```bash
+$ initialize_db development.ini
+$ pserve development.ini
+```
+
+# Special Thanks:
+
+[Nicholas Hunt-Walker](https://github.com/nhuntwalker/)  
+[Twilio](https://github.com/twilio/twilio-python)  
+[Yagmail](https://github.com/kootenpv/yagmail)  
+Charlie, Maelle's son, who suffers from Apraxia

development.ini

@@ -0,0 +1,71 @@
+###
+# app configuration
+# http://docs.pylonsproject.org/projects/pyramid/en/1.7-branch/narr/environment.html
+###
+
+[app:main]
+use = egg:pylistener
+
+pyramid.reload_templates = true
+pyramid.debug_authorization = false
+pyramid.debug_notfound = false
+pyramid.debug_routematch = false
+pyramid.default_locale_name = en
+pyramid.includes =
+    pyramid_debugtoolbar
+
+; sqlalchemy.url = os.environ["DATABASE_URL"]
+
+
+# By default, the toolbar only appears for clients from IP addresses
+# '127.0.0.1' and '::1'.
+# debugtoolbar.hosts = 127.0.0.1 ::1
+
+###
+# wsgi server configuration
+###
+
+[server:main]
+use = egg:waitress#main
+host = 127.0.0.1
+port = 6543
+
+###
+# logging configuration
+# http://docs.pylonsproject.org/projects/pyramid/en/1.7-branch/narr/logging.html
+###
+
+[loggers]
+keys = root, pylistener, sqlalchemy
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = INFO
+handlers = console
+
+[logger_pylistener]
+level = DEBUG
+handlers =
+qualname = pylistener
+
+[logger_sqlalchemy]
+level = WARN
+handlers =
+qualname = sqlalchemy.engine
+# "level = INFO" logs SQL queries.
+# "level = DEBUG" logs SQL queries and results.
+# "level = WARN" logs neither.  (Recommended for production systems.)
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(asctime)s %(levelname)-5.5s [%(name)s:%(lineno)s][%(threadName)s] %(message)s

production.ini

@@ -0,0 +1,68 @@
+###
+# app configuration
+# http://docs.pylonsproject.org/projects/pyramid/en/1.7-branch/narr/environment.html
+###
+
+[app:pylistener]
+use = egg:pylistener
+
+pyramid.reload_templates = false
+pyramid.debug_authorization = false
+pyramid.debug_notfound = false
+pyramid.debug_routematch = false
+pyramid.default_locale_name = en
+
+sqlalchemy.url = sqlite:///%(here)s/pylistener.sqlite
+
+[filter:paste_prefix]
+use = egg:PasteDeploy#prefix
+
+[pipeline:main]
+pipeline = 
+    paste_prefix
+    pylistener
+
+[server:main]
+use = egg:waitress#main
+host = 0.0.0.0
+port = 6543
+
+###
+# logging configuration
+# http://docs.pylonsproject.org/projects/pyramid/en/1.7-branch/narr/logging.html
+###
+
+[loggers]
+keys = root, pylistener, sqlalchemy
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARN
+handlers = console
+
+[logger_pylistener]
+level = WARN
+handlers =
+qualname = pylistener
+
+[logger_sqlalchemy]
+level = WARN
+handlers =
+qualname = sqlalchemy.engine
+# "level = INFO" logs SQL queries.
+# "level = DEBUG" logs SQL queries and results.
+# "level = WARN" logs neither.  (Recommended for production systems.)
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(asctime)s %(levelname)-5.5s [%(name)s:%(lineno)s][%(threadName)s] %(message)s

pylistener/__init__.py

@@ -0,0 +1,15 @@
+from pyramid.config import Configurator
+import os
+
+def main(global_config, **settings):
+    """ This function returns a Pyramid WSGI application.
+    """
+    if "sqlalchemy.url" not in settings:
+        settings["sqlalchemy.url"] = os.environ["DATABASE_URL"]
+    config = Configurator(settings=settings)
+    config.include('pyramid_jinja2')
+    config.include('.models')
+    config.include('.routes')
+    config.include('.security')
+    config.scan()
+    return config.make_wsgi_app()

pylistener/models/__init__.py

@@ -0,0 +1,73 @@
+from sqlalchemy import engine_from_config
+from sqlalchemy.orm import sessionmaker
+from sqlalchemy.orm import configure_mappers
+import zope.sqlalchemy
+
+# import or define all models here to ensure they are attached to the
+# Base.metadata prior to any initialization routines
+from .mymodel import User, AddressBook, Attribute, Category, UserAttributeLink # noqa
+
+# run configure_mappers after defining all of the models to ensure
+# all relationships can be setup
+configure_mappers()
+
+
+def get_engine(settings, prefix='sqlalchemy.'):
+    return engine_from_config(settings, prefix)
+
+
+def get_session_factory(engine):
+    factory = sessionmaker()
+    factory.configure(bind=engine)
+    return factory
+
+
+def get_tm_session(session_factory, transaction_manager):
+    """
+    Get a ``sqlalchemy.orm.Session`` instance backed by a transaction.
+
+    This function will hook the session to the transaction manager which
+    will take care of committing any changes.
+
+    - When using pyramid_tm it will automatically be committed or aborted
+      depending on whether an exception is raised.
+
+    - When using scripts you should wrap the session in a manager yourself.
+      For example::
+
+          import transaction
+
+          engine = get_engine(settings)
+          session_factory = get_session_factory(engine)
+          with transaction.manager:
+              dbsession = get_tm_session(session_factory, transaction.manager)
+
+    """
+    dbsession = session_factory()
+    zope.sqlalchemy.register(
+        dbsession, transaction_manager=transaction_manager)
+    return dbsession
+
+
+def includeme(config):
+    """
+    Initialize the model for a Pyramid app.
+
+    Activate this setup using ``config.include('pylistener.models')``.
+
+    """
+    settings = config.get_settings()
+
+    # use pyramid_tm to hook the transaction lifecycle to the request
+    config.include('pyramid_tm')
+
+    session_factory = get_session_factory(get_engine(settings))
+    config.registry['dbsession_factory'] = session_factory
+
+    # make request.dbsession available for use in Pyramid
+    config.add_request_method(
+        # r.tm is the transaction manager used by pyramid_tm
+        lambda r: get_tm_session(session_factory, r.tm),
+        'dbsession',
+        reify=True
+    )

pylistener/models/meta.py

@@ -0,0 +1,16 @@
+from sqlalchemy.ext.declarative import declarative_base
+from sqlalchemy.schema import MetaData
+
+# Recommended naming convention used by Alembic, as various different database
+# providers will autogenerate vastly different names making migrations more
+# difficult. See: http://alembic.zzzcomputing.com/en/latest/naming.html
+NAMING_CONVENTION = {
+    "ix": 'ix_%(column_0_label)s',
+    "uq": "uq_%(table_name)s_%(column_0_name)s",
+    "ck": "ck_%(table_name)s_%(constraint_name)s",
+    "fk": "fk_%(table_name)s_%(column_0_name)s_%(referred_table_name)s",
+    "pk": "pk_%(table_name)s"
+}
+
+metadata = MetaData(naming_convention=NAMING_CONVENTION)
+Base = declarative_base(metadata=metadata)