program-03-Geolocation

This program focuses on using classes. You will practice with being a client of one class and being the implementer of a second class. The classes store location information for various places of interest. The target application is something like Google Maps where a user can make requests such as asking for restaurants that are near a certain location.

Submit to CodePost files named:

place_information.py place_information_client.py geolocation_client.py geolocation.py geolocator.py search_near.py distance_finder.py places.txt (the entire class file version that I will provide by putting together everyone's records and provide via BlackBoard for you to download)

Part A: Location Data **I ALREADY COMPLETED** - does not need anything from you

Part B: geolocation_client.py

In this part of the assignment you will write client code to manipulate some GeoLocation objects. The GeoLocation class is being provided to you, so you dont have to write it. You will instead be writing code that constructs and manipulates three GeoLocation objects. The popular TV series Breaking Bad made use of geographic location information. The Walter White character buried millions of dollars at a particular location in the desert outside of Albuquerque, New Mexico. He then bought a lottery ticket to help him remember that his stash was buried at a latitude of 34 degrees, 59 minutes, 20 seconds and a longitude of -106 degrees, 36 minutes, 52 seconds. Your client program will compute the distance between Walters stash and the local FBI building and a local studio known as ABQ Studios (where Breaking Bad was filmed). Walters stash was supposedly buried in the desert, but from this client program, youll see that the coordinates they gave on the TV show are really the coordinates of the studio.

Your program is required to produce the following output: the stash is at latitude: 34.988889, longitude: -106.614444 ABQ studio is at latitude: 34.989978, longitude: -106.614357 FBI building is at latitude: 35.131281, longitude: -106.61263 distance in miles between: stash/studio = 0.07548768123801672 stash/fbi = 9.849836190409732

You should use the latitude and longitude values in this log to construct the three GeoLocation objects. You should then print the three objects and call the distance_from method twice to get the desired output. Please note that the latitude/longitude information in the first three lines of output has to be produced by calls on the str method of the GeoLocation class and the values in the final two lines of output have to be produced by calls on the distance_from method of GeoLocation.

Part C: place_information.py

For this part of the assignment, you will write a class called PlaceInformation that stores information about a place of interest. It should have the following public methods:

__init__(name, address, tag, latitude, longitude) get_name() get_address() get_tag() __str__() get_location() distance_from(spot) # spot is a GeoLocation object 

The first three get methods simply return the values that were provided when the object was constructed. The str method should return the name followed by the location details inside parentheses (location details should formatted the same as in the str method for GeoLocation). Although the constructor takes a latitude and longitude, you should store this information inside the PlaceInformation object using a GeoLocation object. The get_location method should return a reference to this GeoLocation object. Remember that in writing your class, you dont want to include code that appears elsewhere. For example, your GeoLocation object knows how to compute a distance, so you should not be repeating the code for computing distances in your PlaceInformation class. You should instead be asking the GeoLocation object to perform the computation. Be sure to properly encapsulate your object with private fields.

Your teacher is providing a client program called place_information_client.py that can be used to test your class. It is in the repository for this assignment.

Part D: search_near.py

For this part of the assignment, you will write the code that parses (reads) the places file. Your teacher is providing a client program called seach_near.py which pulls everything together into a pretty cool geolocation searching app using your PlaceInformation class from Part C as well as all the data you and your colleagues provide in Part A. NOTE: before you can run search_near.py you will need to take care of Google API Key which is described below:

You will need to generate an API key so you can use Google's Mapping services. This will give you some real world exposure to using APIs (application programming interfaces) to get real work done without having to write everything. This part will involve the following:

1. learn about Google APIs - https://en.wikipedia.org/wiki/Google_APIs
2. become familiar with geolocator.py, provided in the repository
3. discover what happens when you try to run search_near.py
4. geolocator is called a Google API to get geo location data; try this in your browser, it is precisely the URL geolocator.py uses to talk with the Google API; https://maps.googleapis.com/maps/api/geocode/xml?sensor=false&address=pentagon
5. Google the error you get and fix this problem which involves 1) registering your own Google API Key; it requires a credit card (for security reasons) BUT DOES NOT CHARGE IT; be sure to read about this at https://developers.google.com/maps/documentation/maps-static/get-api-key 2) install key certification software on your computer; here's the page I used for my Mac: https://timonweb.com/python/fixing-certificate_verify_failed-error-when-trying-requests-html-out-on-mac/; search for something similar for Windows

Here is a video explaining the need for a Google API key: https://www.loom.com/share/3147389476174b61a32bbebb3256e525

After getting your API key setup and added to the geolocator.py file, test the program. Enter "Pentagon" for the target. Look carefully at the results. There is something wrong in the distances that the program displays. There are 2 bugs, actually 1 bug but it occurs in 2 lines of code. Fix this and submit the corrected source code file to CodePost.

PUT A COMMENT AT THE TOP OF THE FILE THAT HAD THE BUG AND EXPLAIN WHAT IT WAS, WHERE IT WAS, HOW YOU FIXED IT. THIS MUST BE INCLUDED TO RECEIVE FULL CREDIT.

Grade Levels

For grade of A: write the distance_from method for GeoLocation class, in addition to the B version; IF YOU DO NOT WISH TO TACKLE THE A VERSION EMAIL ME WITH SUBJECT LINE: "236 distance formula" and I will send you the source code; this code is NOT that difficult once you do a little Googling For grade of B: complete Part D, in addition to the C version For grade of C: complete parts A, B, C

Style Guidelines and Grading:

PlaceInformation is similar to the GeoLocation class, so you can use it as a model for how to write your own class. The GeoLocation class will also provide a useful example of how to comment your class. Each method should be commented and the class itself should have a general comment.

Follow good general style guidelines such as: appropriately using control structures like loops and if/else statements; avoiding redundancy using techniques such as functions, loops, and if/else factoring; good variable names, and naming conventions; and not having any lines of code longer than 100 characters. All fields should be private.

Comment descriptively at the top of your programs, each function, and on complex sections of your code. Comments should explain each functions behavior, parameters and returns.