API Reference

deploy.py

deploy.create_or_update_environment(ssh)

Create environment if non-existent, otherwise update the environment using the .yml file

deploy.git_clone(ssh)

Clone a git repository - defined in user_definition.py

deploy.main()

Implement ssh protocol to connect remotely to amazon server

deploy.run_app(ssh)

1. kill existing gunicorn processes
2. make daemon bash script executable
3. run app as daemon process
4. print app’s port number

deploy.set_crontab(ssh)

set a crontab to run google_search.py and event_brite.py every minute

deploy.ssh_client()

Return ssh client object

deploy.ssh_connection(ssh, ec2_address, user, key_file)

Connect to an SSH server and authenticate

classes.py

class app.classes.LoginForm(formdata=<object object>, **kwargs)

Log in fields

password_entry = <UnboundField(PasswordField, ('Password',), {'validators': [<wtforms.validators.InputRequired object>]})>

submit = <UnboundField(SubmitField, ('Submit',), {})>

username_entry = <UnboundField(StringField, ('Username', [<wtforms.validators.InputRequired object>]), {})>

class app.classes.SurveyForm(formdata=<object object>, **kwargs)

User survey information

age_entry = <UnboundField(SelectField, ('Age',), {'choices': [('under18', 'Under 18'), ('18_24', '18 - 24'), ('25_34', '25 - 34'), ('35_44', '35 - 44'), ('45_54', '45 - 54'), ('55_64', '55 - 64'), ('65_74', '65 - 74'), ('75_84', '75 - 84'), ('older_85', '85 or older')], 'validators': [<wtforms.validators.InputRequired object>]})>

email_entry = <UnboundField(EmailField, ('Email', [<wtforms.validators.InputRequired object>, <wtforms.validators.Email object>]), {})>

first_name_entry = <UnboundField(StringField, ('First Name', [<wtforms.validators.InputRequired object>]), {})>

food_entry = <UnboundField(SelectField, ('Rate your interest in "Food and Drinks" experiences: ',), {'choices': [('5', 'Very Interested'), ('4', 'Interested'), ('3', 'Neither'), ('2', 'Not really interested'), ('1', 'Not interested at all')], 'validators': [<wtforms.validators.InputRequired object>]})>

landmarks_entry = <UnboundField(SelectField, ('Rate your interest in visiting landmarks: ',), {'choices': [('5', 'Very Interested'), ('4', 'Interested'), ('3', 'Neither'), ('2', 'Not really interested'), ('1', 'Not interested at all')], 'validators': [<wtforms.validators.InputRequired object>]})>

last_name_entry = <UnboundField(StringField, ('Last Name', [<wtforms.validators.InputRequired object>]), {})>

museums_entry = <UnboundField(SelectField, ('Rate your interest in visiting museums: ',), {'choices': [('5', 'Very Interested'), ('4', 'Interested'), ('3', 'Neither'), ('2', 'Not really interested'), ('1', 'Not interested at all')], 'validators': [<wtforms.validators.InputRequired object>]})>

music_entry = <UnboundField(SelectField, ('Rate your interest in listening to concerts: ',), {'choices': [('5', 'Very Interested'), ('4', 'Interested'), ('3', 'Neither'), ('2', 'Not really interested'), ('1', 'Not interested at all')], 'validators': [<wtforms.validators.InputRequired object>]})>

nature_entry = <UnboundField(SelectField, ('Rate your interest in "Nature" experiences: ',), {'choices': [('5', 'Very Interested'), ('4', 'Interested'), ('3', 'Neither'), ('2', 'Not really interested'), ('1', 'Not interested at all')], 'validators': [<wtforms.validators.InputRequired object>]})>

nightlife_entry = <UnboundField(SelectField, ('Rate your interest in "Night Life" experiences: ',), {'choices': [('5', 'Very Interested'), ('4', 'Interested'), ('3', 'Neither'), ('2', 'Not really interested'), ('1', 'Not interested at all')], 'validators': [<wtforms.validators.InputRequired object>]})>

password_entry = <UnboundField(PasswordField, ('Password', [<wtforms.validators.InputRequired object>]), {})>

performing_entry = <UnboundField(SelectField, ('Rate your interest in Performing & Visual Arts: ',), {'choices': [('5', 'Very Interested'), ('4', 'Interested'), ('3', 'Neither'), ('2', 'Not really interested'), ('1', 'Not interested at all')], 'validators': [<wtforms.validators.InputRequired object>]})>

submit = <UnboundField(SubmitField, ('Submit',), {})>

username_entry = <UnboundField(StringField, ('Username', [<wtforms.validators.InputRequired object>]), {})>

class app.classes.Trip(name, where, start_date, end_date, creator)

Trip object

creator

end_date

id

name

start_date

where

class app.classes.TripForm(formdata=<object object>, **kwargs)

Trip survey information

end_date_entry = <UnboundField(DateField, ('End Date',), {'format': '%m-%d-%Y'})>

name_entry = <UnboundField(StringField, ('Trip Name',), {'validators': [<wtforms.validators.InputRequired object>]})>

party = <UnboundField(StringField, ('party',), {})>

start_date_entry = <UnboundField(DateField, ('Start Date',), {'validators': [<wtforms.validators.InputRequired object>], 'format': '%m-%d-%Y'})>

submit = <UnboundField(SubmitField, ('Submit',), {})>

where_entry = <UnboundField(StringField, ('Where',), {'validators': [<wtforms.validators.InputRequired object>]})>

class app.classes.User(username, email, password, first_name, last_name, age, food, nightlife, museums, nature, landmarks, music, performing)

User object

age

check_password(password)

email

first_name

food

id

landmarks

last_name

museums

music

nature

nightlife

password_hash

performing

set_password(password)

username

app.classes.load_user(id)

load current user based on their ID

routes.py

app.routes.add_event()

add event to the schedule table for trip

app.routes.connect_to_db()

start a psycopg2 connection to db return engine

app.routes.create_trip()

Allow a user to create a new trip

app.routes.del_event()

add event to the schedule table for trip

app.routes.event_row_to_dic(rec)

converts a row from the event table to a dictionary

app.routes.get_schedule(t_name, suggested=False)

query the schedule table to get either suggested schedule (suggested=True) or current schedule (suggested=False)

app.routes.index()

Home page

app.routes.insert_recs(engine, e)

given a database connection and recommendation, insert into the schedule table

app.routes.login()

Existing user login

app.routes.logout()

Allow a logded in user to logout

app.routes.my_account()

Logged in user account page

app.routes.query_events(start_date, end_date, con)

query the events table based on the start_date and end_date

app.routes.read_key(fname)

reads in secret key from file assumes fname is at base of EC2

app.routes.register()

Sign up

app.routes.rule_rec(event_df, user_ratings, N)

Create event recommendations based on average of scores event_df: Pandas dataframe of queried events user_ratings: list of user ratings N: number of recommendations we would output output: list of dictionaries containing recommendation info

app.routes.scheduler()

app.routes.t_belong(t_name, u_name)

user must belong to trip to see trip

app.routes.trip_name(t_name)

app.routes.unauthorize(e)

route unauthorize users to the login page

google_search.py

api.google_search.clean_text(text)

given a string, remove any tabs

api.google_search.get_attractions(attractions)

updates data for attraction event

api.google_search.insert_attraction(engine, att)

given a database connection and a tabular form of a google event, insert into the attractions table

api.google_search.make_attraction(engine)

given a database connection, create an attraction table

api.google_search.make_tabular_google(result)

given a json object from google search api, manipulate results into tabular form

api.google_search.read_key(fname)

reads in secret key from file assumes fname is at base of EC2

api.google_search.table_exist(engine, table_name)

given an database connection and table, check if table exist in database. return true & false

api.google_search.term_search_api(term)

Uses Google’s Place Search API Given a search term, will search for place and return information about the place as json

eventbrite_search.py

api.eventbrite_search.clean_text(text)

given a string, remove any tabs

api.eventbrite_search.get_events(categories)

using Eventbrites api given a dictionary:

key: category id (specified by eventbrite) value: category names

return list of json files for each category

api.eventbrite_search.insert_event(engine, e)

given a database connection and a tabular form of a eventbrite event, insert into the events table if event does not exit in table

api.eventbrite_search.make_events(engine)

given a database connection, create an events table

api.eventbrite_search.make_tabular_eb(event, cat_name)

given a json object from eventbrite api, manipulate results into tabular form

api.eventbrite_search.read_key(fname)

reads in secret key from file assumes fname is at base of EC2

api.eventbrite_search.table_exist(engine, table_name)

given an database connection and table, check if table exist in database. return true & false