Shopping List Manager

• The shopping list manager is an application like a shopping bot that allows the user to input data and manipulate it according to the user choices and the shopping bot outputs a result based on user choices and input.

• The aim of this program is to help user have a proper planning with shopping list record, this shopping list app is beneficial to users in a lot of ways. First, a user will likely make an improptu decision to impulse buy a product that was never in the plan, this kind of uncontrolled urge will definitly impact the user financially, which the ripple effect can spread all the way to incur debt , it can also be a detriment to a once healthy credit score. However, having a proper planning of the items you want to buy could come in handy as it will help in avoiding over spending, and impulse buying by helping user to focus on what is really needed.

• Secondly, the shopping list program saves user time and energy, not having a list of what to buy at the store makings shopping a headache and time consuming as wider product choices can be a distraction which can be overwhelming sometimes, but if you already have the choice of items you which to buy makes shopping very easy and less time consuming. In the same vein, having a shopping list reduces waste in the sense that when you buy things you do not really need immediatly it most times end up in the trash.

• Further more, it can help in improving user memory and helps user to focus and have proper planning of things.

Features

---

Greeting

• The first thing a user sees when the program is been executed is a display of the program title with a design.

• It asks the user to input a name which is then displayed as a greeting.

Option Menu

• This is a section that shows to the user the options available to choose from.

• This option ranges from 1 to 7.

• Based on user selection the program execute each task accordingly.

Option 1: Add item to list.

• This option allow user to add items to the list.
• It also tells the user if an item has already been added to avoid repetition.

Option 2: View List

• This option displays the content of the list.

• If nothing was previously added, it displays "List is empty, try adding adding an item".

Option 3: Total number of items in the list

• This option displays the total number of items on the list.

• Displays "0" if the list is empty

Option 4: Find items in the list

• The find item in the list option searches the list for a user specified item name, which then search and return a message if the item is found or not

Option 5: Delete items from the list

• The delete item from the list option also searches the list for a user specified item name, which then search and delete the item if found on the list or not.

Option 6: Empty the list

• This erase every content of the list and return it back to an empty list.
• It prints a message based on if the list is already empty or not.

Option 7: Exit program

• This function allows user to exit the program.
• It gives the user an option to chose either to exit or run the program again from the beginning.
• It also print a thank you message to the user based on the time of the day.

Testing

• This program was properly tested using Pep8 online Pep8 .

• All the generated errors like "trailing white spaces and no newline at the end of file were rectified.

• I confirm that all the functionality of this program works perfectly.

Tools used

Language

• Python

Other program used:

• Gitpod:

  • Gitpod: A versatile IDE used to code the program Gitpod

• Github:

  • Github: a platform used for storing, tracking, and collaborating on software projects Github

• Git:

  • Git: Used for version control.

• Pep8:

  • pep8: an online python code checker pep8

• Heroku:

  • Heroku: used in the deployement of the program Heroku

Bugs

• No bugs was found as at the time of deployment.

User Input Validation.

• User input validation
  • The program code was written in a way that it controls any invalid user data input, It allows inputs like "Peanut butter", "Scottish- Whiskey". The error messages were controlled by use of various conditional statements.

Deployment

• The program was deployed to Heroku by following this steps.

• On the Heroku wesbite, create an account.

• After signing in into your account click on create new app button.

• Chose a unique name for the application to be deployed.

• Chose a region.

• Click on settings.

• Navigate to Config var.

• In the Key Value space we need to input PORT for KEY must be in capitals and 800 for PORT

• Click add.

• Click add buildpack, choose python first save changes and add nodjs must be in this order.

• Navigate to the deploy tab on the menu.

• Chose your choice of deployment github is the choice for this project.

• Enter your github repository name and search, if found then click connect.

• Chose to either deploy automatically or manually.

• On this project, our choice is manual deployment, click and wait until a message appear confirming that the application was successfully deployed.

• Click on view app button to run the application.

• The Live link to the deployed program on Heroku Shopping list.

• The github link is Shopping list.

Credits

• Content

  • Insipiration was drawn from Geek tutorials

  • Insipiration to structure the flow Richard

  • Some of the code to validate user data input was from Mrst12

  The aim of the app inspiration was from Positive lending solution

  Acknoledgements

  • Codeinstitute , the slack community, and Codeinstitue mentor support team