Laboratory 3

Laboratory Objectives

1. Explore and use various tools such as: GitHub, VirtualBox, Tuffix, Linux Terminal, and VS Code.
2. Write a Python program using:
   1. lists
   2. loops
   3. conditional statements
   4. input/output
   5. modules
   6. functions using positional and keyword arguments
3. Run and test a Python program.

Getting Started

1. Setting Up Python Environment

   • Verify Python Installation:
   • Open your terminal (Command Prompt for Windows, Terminal for macOS/Linux).
   • Type python --version and press Enter.
   • You should see the installed Python version displayed.

2. Configuring Visual Studio Code (VS Code)

   • Install Python Extension:
   • Open VS Code.
   • Go to the Extensions view by clicking on the Extensions icon in the Activity Bar on the side of the window or by pressing Ctrl+Shift+X.
   • Search for “Python” in the Extensions Marketplace.
   • Click “Install” on the Python extension by Microsoft.

3. Running Python in VS Code

   • Create a New Python File:
   • In VS Code, open a folder where you want to save your Python projects.
   • Click on File > New File or press Ctrl+N to create a new file.
   • Save the file with a .py extension (e.g., hello.py).

Program Instructions

1. Write a Python program that performs as a Tuffy Titan Contact List which contains a list of contacts that can be modified or deleted.

2. Create a contacts module to meet the following requirements:

   1. Create a file named contacts.py.
   2. Add a comment at the top of the file which indicates your name, date and the purpose of the file.
   3. Note: All contact lists within this module should assume the list is of the form: [["first name","last name"],["first name","last name"],...]
   4. Note: All functions should implement a docstring with a simple sentence that describes the function.
   5. Define a function named add_contact to meet the following requirements:
      1. Take a contact list as a positional parameter.
      2. Take a first_name as a keyword parameter.
      3. Take a last_name as a keyword parameter.
      4. Append the first_name/last_name contact to the contact list.
   6. Define a function named modify_contact to meet the following requirements:
      1. Take a contact list as a positional parameter.
      2. Take a first_name as a keyword parameter.
      3. Take a last_name as a keyword parameter.
      4. Take a index as a keyword parameter.
      5. If the index it is within the range of the contact list, modify the appropriate index of the contact list with the first_name/last_name contact, and return a True.
      6. If the index it is not within the range of the contact list, return a False without modifying the contact list.
   7. Define a function named delete_contact to meet the following requirements:
      1. Take a contact list as a positional parameter.
      2. Take a index as a keyword parameter.
      3. If the index it is within the range of the contact list, delete the contact at the index value, and return a True.
      4. If the index it is not within the range of the contact list, return a False without modifying the contact list.
   8. Define a function named sort_contacts to meet the following requirements:
      1. Take a contact list as a positional parameter.
      2. Take a column as a keyword parameter.
      3. If the column is 0, sort the contact list by the first name.
      4. If the column is 1, sort the contact list by the last name.

3. Create a main driver program to meet the following requirements:

   1. Create a file named main.py.
   2. Add a comment at the top of the file which indicates your name, date and the purpose of the file.
   3. Import the contacts module.
   4. Define a variable to use for the contact list.
   5. Implement a menu within a loop with following choices:
      1. Print list
      2. Add contact
      3. Modify contact
      4. Delete contact
      5. Sort list by first name
      6. Sort list by last name
      7. Exit the program
   6. Prompt the user for the menu choice.
   7. Prompt the user for the information needed for the appropriate contacts function and call the function.
   8. Print out appropriate errors with function return values of False.

4. Run the program using the command below and repeat the steps above until you are satisfied your program output meets the above requirements.

   python3 -m main
   

5. Typical input and output for the program:

         *** TUFFY TITAN CONTACT MAIN MENU
   
   1. Print list
   2. Add contact
   3. Modify contact
   4. Delete contact
   5. Sort list by first name
   6. Sort list by last name
   7. Exit the program
   
   Enter menu choice: 2
   
   Enter first name: Richard
   Enter last name: Stallman
   
         *** TUFFY TITAN CONTACT MAIN MENU
   
   1. Print list
   2. Add contact
   3. Modify contact
   4. Delete contact
   5. Sort list by first name
   6. Sort list by last name
   7. Exit the program
   
   Enter menu choice: 2
   
   Enter first name: Bill
   Enter last name: Gates
   
         *** TUFFY TITAN CONTACT MAIN MENU
   
   1. Print list
   2. Add contact
   3. Modify contact
   4. Delete contact
   5. Sort list by first name
   6. Sort list by last name
   7. Exit the program
   
   Enter menu choice: 2
   
   Enter first name: Steve
   Enter last name: Jobs
   
         *** TUFFY TITAN CONTACT MAIN MENU
   
   1. Print list
   2. Add contact
   3. Modify contact
   4. Delete contact
   5. Sort list by first name
   6. Sort list by last name
   7. Exit the program
   
   Enter menu choice: 1
   
   ================== CONTACT LIST ==================
   Index   First Name            Last Name
   ======  ====================  ====================
   0       Richard               Stallman              
   1       Bill                  Gates                 
   2       Steve                 Jobs                  
   
         *** TUFFY TITAN CONTACT MAIN MENU
   
   1. Print list
   2. Add contact
   3. Modify contact
   4. Delete contact
   5. Sort list by first name
   6. Sort list by last name
   7. Exit the program
   
   Enter menu choice: 3
   
   Enter the index number: 2
   Enter first name: Tim
   Enter last name: Cook
   
         *** TUFFY TITAN CONTACT MAIN MENU
   
   1. Print list
   2. Add contact
   3. Modify contact
   4. Delete contact
   5. Sort list by first name
   6. Sort list by last name
   7. Exit the program
   
   Enter menu choice: 1
   
   ================== CONTACT LIST ==================
   Index   First Name            Last Name
   ======  ====================  ====================
   0       Richard               Stallman              
   1       Bill                  Gates                 
   2       Tim                   Cook                  
   
         *** TUFFY TITAN CONTACT MAIN MENU
   
   1. Print list
   2. Add contact
   3. Modify contact
   4. Delete contact
   5. Sort list by first name
   6. Sort list by last name
   7. Exit the program
   
   Enter menu choice: 3
   
   Enter the index number: 5
   Enter first name: Mickey
   Enter last name: Mouse
   Invalid index number.
   
         *** TUFFY TITAN CONTACT MAIN MENU
   
   1. Print list
   2. Add contact
   3. Modify contact
   4. Delete contact
   5. Sort list by first name
   6. Sort list by last name
   7. Exit the program
   
   Enter menu choice: 6
   
         *** TUFFY TITAN CONTACT MAIN MENU
   
   1. Print list
   2. Add contact
   3. Modify contact
   4. Delete contact
   5. Sort list by first name
   6. Sort list by last name
   7. Exit the program
   
   Enter menu choice: 1
   
   ================== CONTACT LIST ==================
   Index   First Name            Last Name
   ======  ====================  ====================
   0       Tim                   Cook                  
   1       Bill                  Gates                 
   2       Richard               Stallman              
   
         *** TUFFY TITAN CONTACT MAIN MENU
   
   1. Print list
   2. Add contact
   3. Modify contact
   4. Delete contact
   5. Sort list by first name
   6. Sort list by last name
   7. Exit the program
   
   Enter menu choice: 5
   
         *** TUFFY TITAN CONTACT MAIN MENU
   
   1. Print list
   2. Add contact
   3. Modify contact
   4. Delete contact
   5. Sort list by first name
   6. Sort list by last name
   7. Exit the program
   
   Enter menu choice: 1
   
   ================== CONTACT LIST ==================
   Index   First Name            Last Name
   ======  ====================  ====================
   0       Bill                  Gates                 
   1       Richard               Stallman              
   2       Tim                   Cook                  
   
         *** TUFFY TITAN CONTACT MAIN MENU
   
   1. Print list
   2. Add contact
   3. Modify contact
   4. Delete contact
   5. Sort list by first name
   6. Sort list by last name
   7. Exit the program
   
   Enter menu choice: 4
   
   Enter the index number: 1
   
         *** TUFFY TITAN CONTACT MAIN MENU
   
   1. Print list
   2. Add contact
   3. Modify contact
   4. Delete contact
   5. Sort list by first name
   6. Sort list by last name
   7. Exit the program
   
   Enter menu choice: 1
   
   ================== CONTACT LIST ==================
   Index   First Name            Last Name
   ======  ====================  ====================
   0       Bill                  Gates                 
   1       Tim                   Cook                  
   
         *** TUFFY TITAN CONTACT MAIN MENU
   
   1. Print list
   2. Add contact
   3. Modify contact
   4. Delete contact
   5. Sort list by first name
   6. Sort list by last name
   7. Exit the program
   
   Enter menu choice: 4
   
   Enter the index number: 5
   Invalid index number.
   
         *** TUFFY TITAN CONTACT MAIN MENU
   
   1. Print list
   2. Add contact
   3. Modify contact
   4. Delete contact
   5. Sort list by first name
   6. Sort list by last name
   7. Exit the program
   
   Enter menu choice: 7
   

6. Run the unit testing program to ensure that your program runs as expected.

   ./test.sh
   

   The unit testing will output the results of a series of tests using specific input and expected output. Any error will provide information on where the expected output is different from the actual output. You will need to edit your source code to fix the error and run ./test.sh repeatedly until it passes all the test.

Submission

Submit a zip file containing all the code files on canvas

Naming Convention: _.zip

Your zipped folder should contain below files:

CWID_LASTNAME.zip -
                  | > test.py
                  | > test.sh
                  | > main.py
                  | > contacts.py
                  | > test.txt
                  | > win_test.bat

Grading

1. All points add up to a total of 100 points possible as detailed below. Partial credit will be given where applicable.

Points	Description
50	Environment setup and Lab Submission
11	main.py file submitted contains the main driver program and meets the program requirements
11	contacts.py file submitted contains the contacts module and meets the program requirements
4	unit test passes Test01_AddContact
4	unit test passes Test02_ModifyContact
4	unit test passes Test03_ModifyContact
4	unit test passes Test04_DeleteContact
4	unit test passes Test05_DeleteContact
4	unit test passes Test06_SortContacts
4	unit test passes Test07_SortContacts