Tell-Me-Where-To-Live is an application that helps home seekers conduct preliminary research by searching all neighborhoods that meet their commute needs (e.g. the distance from their target location based on zipcode). It returns the list of neighborhoods home seekers could potentially consider, as well as all the housing listings in these neighborhoods classified by price range. The application allows home seekers to learn the affordability of the neighborhoods in a few seconds so they can plan forward.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
-
Anaconda 3.7
-
Python 3.7
-
Pip
-
uszipcode:
Install:
$ pip install uszipcode
To upgrade to latest version:
$ pip install --upgrade uszipcode
For further exploration, see documentation
https://pypi.org/project/uszipcode/ -
PySimpleGUI:
Install:
$ pip install PySimpleGUI
For further exploration, see documentation
https://pypi.org/project/PySimpleGUI/ -
zipcodes:
Install
$ pip install zipcodes
For further exploration, see documentation
https://pypi.org/project/zipcodes/
A step by step series of examples that tell you how to get a local copy of application running
When you install Python, you also get Python's package manager, pip. You can use pip to install and manage third-party Python packages. For this Project, first create and activate a new Anaconda virtual environment, perhaps named "tell-me-where-to-live-env":
conda create -n tell-me-where-to-live-env
conda activate tell-me-where-to-live-env
Then install package dependencies by specifying the requirements:
pip install -r requirements.txt
Then navigate to your local root path and execute the script by running the command below:
python app/webRequest.py
This project requires only a gitignore to ensure caches (pycache. and pytest_cache) caused by automated testings will not interupt the execution of the program. No other envrionment setting is currently needed as this code retrieves data using a third party package, not API keys.
As mentioned above, no confidential information will be used so security setting is unnecessary.
To run automated tests, consider installing pytest using pip:
$ pip install pytest
The pytest package is generally used as a command-line utility for running pre-defined files of "test" code.
Navigate to the local root path, and invoke pytest using the command below:
pytest #> 1 passed in 0.01 seconds
As this application contains a graphica user interface created by PySimpleGUI, using local envrionment is recommended. Further exploration needs to be done for online deployment.
Wenhui Fang, a senior at Georgetown University and a python beginner
This project is licensed under the MIT License - see the LICENSE.md file for details
This project is inspired by Prof. Michael Rossetti, who teaches OPIM 244 - Managing Business Application in Python at Georgetown University. Here is a link to his github: https://github.com/prof-rossetti. In addition, I have adopted my GUI from https://pypi.org/project/PySimpleGUI/