submission

.coveragerc

@@ -0,0 +1,7 @@
+[run]
+omit = 
+    opportune/test*
+    opportune/__init__.py
+    opportune/models/__init__.py
+    opportune/models/meta.py
+    opportune/scripts/*

.gitignore

@@ -0,0 +1,119 @@
+
+# Created by https://www.gitignore.io/api/python
+
+.DS_STORE
+.vscode
+
+Data.fs*
+*.sublime-project
+*.sublime-workspace
+.*.sw?
+.sw?
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*.pyc
+*$py.class
+*~
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+.pytest_cache/
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+tmp/
+
+# Translations
+*.mo
+*.pot
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule.*
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+env*/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+
+# End of https://www.gitignore.io/api/python

.travis.yml

@@ -0,0 +1,24 @@
+language: python
+python:
+  - "3.6"
+
+services:
+  - postgresql
+
+before_script:
+  - psql -c "create database opportune_test;" -U postgres
+
+#set some environment variables
+env:
+  - TEST_DATABASE_URL='postgres://127.0.0.1:5432/opportune_test'
+
+# command to install dependencies
+install:
+  - pip install -e .[testing]
+
+# commands to run tests
+script:
+  - pytest
+
+notifications:
+  email: false

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "python.pythonPath": "/usr/local/bin/python3"
+}

CHANGES.txt

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

MANIFEST.in

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

Procfile

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

README.md

@@ -1 +1,114 @@
-# Mildly-Sketchy
+# Opportune
+
+**Author**: Kat Cosgrove, Gene Pieterson, Patricia Raftery, Austin Matteson
+**Version**: 1.4.1
+
+## Overview
+
+Opportune is a web application that uses a web scraper and keywords from the user to find jobs in their area related to their chosen search terms. To use, the user must register or log in, choose their location and job keywords, and Opportune will email to them a list of 20 job postings within their specifications. Their results will also be displayed on their profile page. At any time the user can go back and search again, with different keywords/city, or if they use the same they will not get the same job postings again. The user has the ability to delete or add keywords, change their email, or fully delete their account. Data analysis is displayed to the user on salaries for different keyword searches.
+
+## How It Works
+
+This application returns 30 job postings to the user on submit of their location and keyword preferences. It does this by using Beautiful Soup to scrape Indeed.com. The results are stored in a csv file and emailed to the user, and also displayed on their profile page. Data analysis is done on common keyword searches in Seattle comparing salaries using Jupyter Notebook and Bokeh.
+
+## Getting Started
+
+To replicate this app, you would fork and clone our GitHub https://github.com/Mildly-Sketchy/Opportune. Then you would need to start a virtual environment, install the packages to get the dependencies used in this app, and have 3 empty databases set up.
+
+## Architecture
+
+Three SQL databases are used for persistence to store job postings and user data. Pyramid is used for the framework, and the web scraper used is Beautiful Soup. Other technologies used are Python3, Travis CI, Jupyter notebook, pandas, Bokeh, HTML, CSS, and JavaScript. Heroku is used for deployment.
+
+## Change Log
+
+#### Prework
+
+04/10/2018 1400 - Discussed project ideas
+
+04/11/2018 1400 - Selected project idea
+
+04/12/2018 1400 - Did wireframes and planning
+
+04/13/2018 1400 - Created repository
+
+04/13/2018 1400 - Created front-end mock-ups
+
+04/15/2018 1400 - Created Pyramid framework
+
+#### Day 1
+
+04/16/2018 1000 - Deployed scaffolded site with Heroku
+
+04/16/2018 1100 - Travis CI utilized
+
+04/16/2018 1200 - CSV with test data can be successfully emailed to the user
+
+04/16/2018 1300 - Databases dropped and rebuilt
+
+04/16/2018 1400 - Update gitignore
+
+04/16/2018 1430 - Basic web scraper functionality achieved within a jupyter notebook
+
+04/16/2018 1500 - Web scraper transfered to the proper file in Pyramid, still works
+
+#### Day 2
+
+04/17/2018 0900 - Keywords can be stored in the SQL database
+
+04/17/2018 0930 - Web scraper now accepts keywords stored in the database
+
+04/17/2018 1030 - Web scraper can accept a single city and multiple job keywords
+
+04/17/2018 1130 - Basic tests written for views, coverage at 54%
+
+04/17/2018 1245 - Keywords can be deleted from the database
+
+04/17/2018 1330 - Dummy data file created for testing scraper, using the data from Indeed with the python keyword
+
+04/17/2018 1430 - The user can add keywords to their account, they display on their profile page, and can be selectively deleted
+
+04/17/2018 1500 - Test for web scraper works. Test uses monkey patch to direct the scraper to the dummy data
+
+04/17/2018 1600 - User's results are written to a csv and displayed on the profile page
+
+04/17/2018 1700 - More styling and formatting done on the front end to make buttons look more appealing, improve organization
+
+#### Day 3
+
+04/18/2018 0900 - Merge developmenent branch to master branch, redeploy
+
+04/18/2018 1030 - The user can update their email address or delete their entire account
+
+04/18/2018 1130 - Front end styling for search page
+
+04/18/2018 1230 - Testing with fake authenticated user can post keywords, passes
+
+04/18/2018 1300 - Tests broken up in to different files
+
+04/18/2018 1400 - Data Analysis for different properties of dev related keywords
+
+#### Day 4
+
+04/19/2018 0900 - 401 redirect for bad login caught, scraper now returns job summaries
+
+04/19/2018 1000 - Small UI issues corrected, admin permissions for analytics page in place
+
+04/19/2018 1100 - Forbidden view and existing username tests added
+
+04/19/2018 1200 - Mass scraper notebook with CSV files added
+
+04/19/2018 1300 - Data analysis done on the user's keyword searches and is displayed to the user's profile
+
+04/19/2018 1400 - Test coverage is 85%
+
+04/19/2018 1600 - Test coverage is 95%
+
+04/19/2018 1800 - About Us page, pictures and descriptions added, styling done
+
+#### Day 5
+
+04/20/2018 0900 - Bug fixes with scraper and email
+
+04/20/2018 1000 - LinkedIn and GitHub links added to About Us page, better styling done
+
+04/20/2018 1400 - Presentation

README.txt

@@ -0,0 +1,33 @@
+opportune
+=========
+
+Getting Started
+---------------
+
+- Change directory into your newly created project.
+
+    cd opportune
+
+- Create a Python virtual environment.
+
+    python3 -m venv env
+
+- Upgrade packaging tools.
+
+    env/bin/pip install --upgrade pip setuptools
+
+- Install the project in editable mode with its testing requirements.
+
+    env/bin/pip install -e ".[testing]"
+
+- Configure the database.
+
+    env/bin/initialize_opportune_db development.ini
+
+- Run your project's tests.
+
+    env/bin/pytest
+
+- Run your project.
+
+    env/bin/pserve development.ini

development.ini

@@ -0,0 +1,71 @@
+###
+# app configuration
+# https://docs.pylonsproject.org/projects/pyramid/en/latest/narr/environment.html
+###
+
+[app:main]
+use = egg:opportune
+
+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 = postgres://localhost:5432/opportune_dev
+
+retry.attempts = 3
+
+# 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
+listen = localhost:6543
+
+###
+# logging configuration
+# https://docs.pylonsproject.org/projects/pyramid/en/latest/narr/logging.html
+###
+
+[loggers]
+keys = root, opportune, sqlalchemy
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = INFO
+handlers = console
+
+[logger_opportune]
+level = DEBUG
+handlers =
+qualname = opportune
+
+[logger_sqlalchemy]
+level = INFO
+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