CP1404/CP5632 Assignment 1 – Travel Tracker 1.0

Hello, dear friend, you can consult us at any time if you have any questions, add WeChat: daixieit

CP1404/CP5632 Assignment 1 – Travel Tracker 1.0

Task:

You are to write a Python (3) program, as described in the following information and sample output. This assignment will help you build skills using selection, repetition, file input/output, exceptions, lists, functions and string formatting. Do not define any of your own classes or use constructs that haven't been taught in this subject. Assignment 2 will build on this with more advanced constructs including dictionaries, classes and a Graphical User Interface (GUI).

Some requirements have in-text help references, like [0], that refer to the resources list near the bottom of this document. Please check these references to find help on that topic.

Everything you need to complete this assignment can be found in the subject materials.

Start your work by clicking this link to create a new repository in GitHub Classroom:

https://classroom.github.com/a/aw7JLb1S

Do not use any other repo or a copy of this one... just use this actual repository!

This will give you a new repo containing starter files including a README for your project, all of which you must use. Do not add any other files in this project, and do not rename anything - just use this as your assignment repo. Do not "download" this repo, but rather checkout this repo using PyCharm ("Get from Version Control").

Program Overview:

This program is a simple "travel tracker" that allows a user to track places they wish to visit and places they have already visited. The program reads and writes a list of places in a text file, and each place has:

● name, country, priority, whether it is visited (v) or unvisited (n)

Users can choose to see the list of places, including the total number of places and unvisited places. The list will be sorted by visited status then by priority (decreasing number). [1]

Did you see that reference? Look below for [1] and you’ll find out where we have taught you how to sort lists by multiple keys.

Users can add new places and mark places as visited.

They cannot change places from visited to unvisited.

Program Functionality Details:

Ensure that your program has the following features, as demonstrated in the sample output below. Your program should:

● display a welcome message with your name in it

● display a menu for the user to choose from [2, 3]

● error-check user inputs as demonstrated in the sample output [4]

● load a CSV (Comma Separated Values) file of places (just once at the very start); a sample CSV file is provided for you and you must use this format [5] (note: you're not expected to use the csv module, but you're welcome to)

● when the user chooses list: display a neatly formatted (lined up) list of all the places with their details and the number of places left to visit [4]. Unvisited places should have a * next to them. Note that the lining up is dynamic, based on the longest place name and country [6]

● when the user chooses recommend: display a random choice from any available unvisited places

○ if there are no unvisited places, then "No places left to visit!" should be displayed

● when the user chooses add: prompt for the place’s name, country and priority, error-checking each of these [3], then add the place to the list in memory (not to the file); new places are always unvisited

● when the user chooses mark visited: display the list of all places (same as for the list option), then allow the user to choose one place (error-checked), then change that place to visited

○ if there are no unvisited places, then "No unvisited places" should be displayed

● when the user chooses quit: save the places to the CSV file, overwriting the file contents (note that this should be the only time that the file is saved)

Coding Requirements and Suggestions:

● Work incrementally on this task: complete small parts of it at a time rather than trying to get it all working at once.

● You are assessed on your use of version control including commits and commit messages, so please commit regularly (each logical chunk or milestone) and use meaningful commit messages in the imperative voice, as taught in class. Your commits should show steady work completed over reasonable time, not all in a short period.

● Edit the module docstring at the very top of your code file to contain your own details.

● Make use of named constants as appropriate (e.g., for the characters that represent the song's learned/unlearned status).

● Use functions appropriately for each significant part of the program: this is the divide-and-conquer problem-solving approach. Follow the principles you've learned about functions, including the single responsibility principle (SRP).

● Only load (read) the places file once, when the program starts.

● Only save (write) the places file once, when the program ends.

● Store the place data in a list of lists and pass that to any functions that need access to it. Note: this variable should not be global. The only global variables you may have are CONSTANTS. (Did you understand this? If you use global variables, your functions will be poorly designed. Do not use any global variables.)

● Do not store a place's index – this is just its position in the list.

● The menu choice should handle uppercase and lowercase letters.

● Use exception handling where appropriate to deal with input errors (including entering numbers and selecting places). You should be able to use generic, customisable functions to perform input with error checking (e.g., getting the place name and country can reuse the same function).

● The output shows that the solution does not require correct plurals (e.g., "1 places"). You are welcome to leave yours this way. You may add logic to print these statements correctly, but it is not expected or assessed.

Check the rubric carefully to understand how you will be assessed. There should be no surprises here – this is about following the best practices we have taught in class.

Output Requirements:

Sample output from the program is provided below. Ensure that your program matches this, including spaces, spelling, and the formatting of the place lists. Think of this as helpful guidance as well as training you to pay attention to detail. The sample output is intended to show a large (but maybe not exhaustive) range of situations including user input error handling.

Integrity:

The work you submit for this assignment must be your own. Submissions that are detected to be too similar to that of another student or other work (e.g., code found online) will be dealt with according to the College procedures for handling plagiarism and may result in serious penalties.

The goals of this assignment include helping you gain understanding of fundamental programming concepts and skills, and future subjects will build on this learning. Therefore, it is important that you develop these skills to a high level by completing the work and gaining the understanding yourself. You may discuss the assignment with other students and get assistance from your peers, but you may not do any part of anyone else’s work for them and you may not get anyone else to do any part of your work. Note that this means you should never give a copy of your work to anyone or accept a copy of anyone else’s work, including looking at another student's work or having a classmate look at your work. If you require assistance with the assignment, please ask general questions on the discussion forum, or get specific assistance with your own work by talking with your lecturer or tutor.

The subject materials (lecture notes, practicals, textbook and other guides provided in the subject) contain all of the information you need for this particular assignment. You should not use online resources (e.g., Stack Overflow or other forums) to find resources or assistance as this would limit your learning and would mean that you would not achieve the goals of the assignment - mastering fundamental programming concepts and skills.

Submission:

Zip up your project/repo directory as it is, then submit this zip file. Ensure that you do NOT include a venv. Name the file like: FirstnameLastnameA1.zip. Upload your single zip file on LearnJCU under Assessment (click on the title of the assignment).

Due:

Submit your assignment by the date and time specified on LearnJCU. Submissions received after this date will incur late penalties as described in the subject outline.

Sample Output:

The following sample run was made using a CSV file that contained:

You should be able to figure out what parts of the sample output below are user input.

At the end of this run, the saved CSV file contained:

References – Resources from Subject Materials:

Selected subject materials are referenced here to help you find guidance for specific parts of the assignment (e.g., sorting a list by multiple values is covered in [1] and you will find a template for writing menus for console programs in [2]).

General references are not listed specifically but should be obvious (e.g., file input/output is covered in the lecture and practical on files).

You should find the programming patterns "cheat sheet" helpful for a number of things: https://github.com/CP1404/Starter/wiki/Programming-Patterns

1.      itemgetter from Chapter 7 - Lists and Tuples.

2.      Practical 01 - PyCharm, Control.

https://github.com/CP1404/Practicals/tree/master/prac_01

3.      Programming Patterns. https://github.com/CP1404/Starter/wiki/Programming-Patterns

4.      Practical 02 - Strings, Files, Exceptions.

https://github.com/CP1404/Practicals/tree/master/prac_02

5.      Chapter 5 - Files and Exceptions 1.

6.      Practical 05 - Dictionaries, Code Reviews with PRs.

https://github.com/CP1404/Practicals/tree/master/prac_05

7.      Negotiating the Maze of Academic Integrity in Computing Education.

https://dl.acm.org/citation.cfm?doid=3024906.3024910

Marking Scheme:

Ensure that you follow the processes and guidelines taught in class in order to produce high quality work. Do not just focus on getting the program working. This assessment rubric provides you with the characteristics of exemplary, good, competent, marginal and unacceptable work in relation to task criteria.

Criteria	Exemplary (9, 10)	Good (7, 8)	Satisfactory (5, 6)	Limited (2, 3, 4)	Very Limited (0)
Correctness   Worth double	Program works correctly for all   functionality required.	Exhibits aspects of exemplary   (left) and satisfactory (right)	Program mostly works correctly   for most functionality, but there   is/are some required aspects   missing or that have problems.	Exhibits aspects of satisfactory   (left) and very limited (right)	Program works incorrectly for all   functionality required.
Error checking	Invalid inputs are handled well   using exceptions and control   logic as instructed, for all user   inputs.		Invalid inputs are mostly handled   correctly as instructed, but there   is/are some problem(s), e.g.,   exceptions not well used.		Error checking is not done or is   very poorly attempted.
Similarity to   sample output   (including all   formatting)	All outputs match sample output   perfectly, or only one minor   difference, e.g., wording,   spacing.		Multiple differences (e.g., typos,   spacing, formatting) in program   output compared to sample   output.		No reasonable attempt made to   match sample output. Very many   differences.
Identifier naming	All function, variable and   constant names are appropriate,   meaningful and consistent.		Multiple function, variable or   constant names are not   appropriate, meaningful or   consistent.		Many function, variable or   constant names are not   appropriate, meaningful or   consistent.
Use of code   constructs	Appropriate and efficient code   use, including good logical   choices for data structures and   loops, good use of constants, etc.		Mostly appropriate code use but   with definite problems, e.g.,   unnecessary code, poor choice of   data structures or loops, no use   of constants.		Many significant problems with   code use.
Use of functions	Functions and parameters are   appropriately used, functions are   well reused to avoid code   duplication.		Functions used but not well, e.g.,   incorrect/missing parameters or   calls, unnecessary duplication or   main code outside main function.		No functions used or functions   used very poorly.
Formatting	All formatting is appropriate,   including correct indentation,   horizontal spacing and consistent   vertical line spacing. PyCharm   shows no formatting warnings.		Multiple problems with formatting   reduces readability of code.   PyCharm shows formatting   warnings.		Readability is poor due to   formatting problems. PyCharm   shows many formatting warnings.
Commenting	Helpful block/inline comments   and meaningful docstrings for all   functions, top docstring contains   all program details (name, date,   basic description, GitHub URL).		Comments contain some noise   (too many/unhelpful comments)   or some missing program details   in top docstring or some   inappropriate or missing   block/inline comments.		Commenting is very poor either   through having too many   comments (noise) or too few   comments.
Use of version   control	Git/GitHub used effectively and   the repository contains a good   number of commits with good   messages that demonstrate   incremental code development.		Aspects of the use of version   control are poor, e.g., not many   commits, meaningless messages   that don’t represent valuable   incremental development.		Git/GitHub not used at all.