Portfolio Project 3 - Python Essentials

Link to live site

Link to google sheet used for the data storage

• Project Goals
  • User Stories
• User Manual
• Technical Design
  • Flowchart
  • Data Models
  • User Interface
• Technologies Used
• Features
• Validation
• Testing
• Bugs
• Deployment
• Credit
• Acknowledgements

To create a system for managing personal training session bookings from both a user perspective and a staff member perspective. The experience needs to be simple and easy follow due to this being run through command line only. Options need to be given to the user at all times so that they don't feel stuck along the way.

1. As a First Time Visitor I want to be able to book a personal training session.
2. As a First Time Visitor I want to be able to choose the trainer I want to book with.
3. As a First Time Visitor I want to get feedback from the site through the process.
4. As a First Time Visitor I want to be able to check my bmi score

5. As a Returning Visitor I want to be able to view the sessions I have booked.
6. As a Returning Visitor I want to be able to book another session
7. As a Returning Visitor I want to be able to check my bmi score

8. As a Staff Member I want to be able to see who has booked for what sessions.
9. As a Staff Member I want to be able to add additional sessions for people to book.
10. As a Staff Member I would like a user to only be able book on certain dates.

11. As a Site Owner I want users to be able to login to the system and book sessions.
12. As a Site Owner I want to be able to validate all of the user input and provide feedback if input is invalid.
13. As a Site Owner I would like users to be able to get back to the welcome screen at any point through the process.
14. As a Site Owner I would like to get basic medical information from the user when they create a new account

Ironworks Personal Trainer Booking System requries user input for the system to work. For this reason the sytem has been built in a way that is easy for the user to navigate by providing the user with options at each point. The system also takes in user input for passing through to the google sheet where data is stored or it uses it to workout a computation for the user and provides the answer back to them. By chaining the functions together the system can reuse inputs rather than asking the user for the same information again.

Screenshot of welcome screen

This is the first screen that the user sees when the application runs. For the user to move on their are 2 options:

• login - takes the user to login to their account if they have one. Section 3
• create account - takes the user to create a new account if they don't have an account. Section 2

Screenshot of create account screen

At the create account screen you will be asked for the username you would like to register with. When you have entered your desired username the system will check to see if it is available. If its not available you should get an error message saying that and asking for you to try again. Once an available username is entered it will take you to complete a basic medical form. Following that you will be presented with 2 options:

• login - takes the user to their account. Section 3
• exit - takes user back to welcome screen. Section 1

Screenshot of login screen

Much like with the create account, the login page asks you to enter a username. Difference this time is it will check to see if it exists and allow you to move to the next screen. If you login with a user account then you will be presented with 3 options:

• book - takes you to the part of the system where you can book a session with one of the trainers. Section 4
• booked sessions - takes you to view the sessions you have booked. Section 5
• BMI calculation - takes you to where with a input of weight and height from the user it can calculate their BMI. Section 6

Screenshot of book screen

When selected to go to book a session as a user you will first be shown a list of available dates for each trainer. The system then asks who you would like to book with. It checks to see if your selection is valid and if so it will then ask you for the date you would like to book. Date format to use is dd-mm-yyyy and if a valid date is entered it will confirm this back to you.

Screenshot of booking confirmation screen

Following that you are presented with 2 options:

• booked sessions - takes you to view the sessions you have booked. Section 5
• exit - takes user back to welcome screen. Section 1

Screenshot of booked screen

The booked sessions screen shows you the session dates that are booked with which trainer. At the end it gives you 2 options:

• book - takes you to the part of the system where you can book a session with one of the trainers. Section 4
• exit - takes user back to welcome screen. Section 1

Screenshot of BMI calculation screen

The BMI calculation allows you to enter your weight and height and it will return your score. Only the score is provided and no interpretation of what that score means is given. This is for calculation purposes only. Once done it will provide you with 2 options:

• booked sessions - takes you to view the sessions you have booked.
• book - takes you to the part of the system where you can book a session with one of the trainers. Section 4
• exit - takes user back to welcome screen. Section 1

Screenshot of staff sessions screen

When you login with a staff account you can view booked sessions or add a new session. By selecting view booked sessions it will show you a list of the sessions you have made available and if any of the dates have been booked it will show the name of the person who has booked that session. At the end it gives you 2 options:

• add a new session - this allows a staff member to make a new date available for people to book. Section 8
• exit - takes user back to welcome screen. Section 1

Screenshot of add a new session screen

The second option in a staff account is being able to make an additional date available. The system will ask you for the date that you would like to add. Once it has check that this date is not currently in use it will add it and users will be able to book that session. After that has completed you are given 2 options:

• view scheduled sessions - takes the user to view their sessions. Section 7
• exit - takes user back to welcome screen. Section 1

This is the user google worksheet found in the ironworks google sheet. This sheet holds the usernames and the account type of 'User' or 'Staff'. It is updated when a new user account is created.

This is the worksheet named steve and is found in the ironworks google sheet. The sheet holds the scheduled dates and if it is 'AVAILABLE' or if a user has booked it it shows the username. The sheet is updated when a user books a new session or steve adds a new scheduled session.

This is the worksheet named karen and is found in the ironworks google sheet. The sheet holds the scheduled dates and if it is 'AVAILABLE' or if a user has booked it it shows the username. The sheet is updated when a user books a new session or karen adds a new scheduled session.

This is the parq worksheet found in the ironworks google sheet. The sheet holds the information submitted by the user when they complete the PARQ form after creating an account. The worksheet is updated once a user has completed the form in the app.

The flowchart for this site was created in Lucid Charts and can be seen below.

1. Flowchart

   

I have used various data models within this project. A Class has been used to for the BMI calc as it can take in attributes and use a method to do the calculation of BMI using those attributes. Dictionaries have been used to pair up the dates with the users who have booked. Lists have also been used throughout the site.

Due to the nature of this project in that the focus is on using the python there isn't much flexibility in making an aesthetically pleasing site. That being said I focused on making the system as easy to use as possible. This is done by giving simple options allowing easier interaction for the user. When more than a single option is needed I have tried to explain what exactly the user needs to enter and if a specific format is needed then show that.

• Python

• Git Used for version control of the site and push code from VScode to Github
• Github Used as the remote repository to store the code. Github pages is also where the live site is hosted.
• Gitpod Used as the IDE for writing the code and file management
• Lucid Charts Used to create flowchart for the site
• Heroku Used to deploy the application.
• Google Sheets Users input data edits content on within Google Sheets
• Google Cloud Platform All data send and received using the Google API through the Google Cloud Platform

• google.oauth2.service_account:

Allows the application to access the google API without storing the usernames and passwords of the google accounts in the application files its self. A creds.json file is created with all details the API needs to access the google account. In deployment to heroku this information is store in the config var section.

• gspread:

Allows the application to access google sheets created by the site owner. Using various commands the app can open, select, create or delete worksheets. It can also get cell values, update cell values, append to whole rows, find data within a worksheet or get cell properties. This has allowed the app do everything it does as the data is stored in the google sheet and most all of the functions rely on access the worksheet.

This site has 3 features

Create account has 2 main sections to it:

1. Choose a username
2. PARQ form

Allows a user to create an account if they don't have one. Input username is checked to see if it is available. If that passes then the username is appended to the users google worksheet and the app takes the user to the PARQ form.

PARQ form is to gather some basic medical information for the personal trainer before the user comes in for a session. The app asks the user for some inputs and then those inputs are stores within the parq google worksheet.

3 As a First Time Visitor I want to get feedback from the site through the process.

12 As a Site Owner I want to be able to validate all of the user input and provide feedback if input is invalid.

14 As a Site Owner I would like to get basic medical information from the user when they create a new account

User account has 3 main sections to it:

1. Book a session
2. View booked sessions
3. Use BMI calculator

One of the largest functions in the app. It starts with showing the available sessions to book for each trainer. Then allows the user to select which trainer they want to book with. Finally the user enters which date they want to book which is checked to see if available and if so the users username is put against that trainer and date in the relevant trainer google worksheet.

This displays a list of sessions the user has booked and who with.

This section of the app asks the user for 2 inputs of weight and height. It then returns the BMI score based on those inputs.

1 As a First Time Visitor I want to be able to book a personal training session.

2 As a First Time Visitor I want to be able to choose the trainer I want to book with.

3 As a First Time Visitor I want to get feedback from the site through the process.

4 As a First Time Visitor I want to be able to check my bmi score.

5 As a Returning Visitor I want to be able to view the sessions I have booked.

6 As a Returning Visitor I want to be able to book another session.

7 As a Returning Visitor I want to be able to check my bmi score.

11 As a Site Owner I want users to be able to login to the system and book sessions.

12 As a Site Owner I want to be able to validate all of the user input and provide feedback if input is invalid.

13 As a Site Owner I would like users to be able to get back to the welcome screen at any point through the process.

Staff account has 2 main sections to it:

1. View scheduled sessions
2. Add a new scheduled session

Displays the scheduled sessions for users with a staff account. It gets the data from the relevant google worksheet and shows the dates they currently have scheduled and either 'AVAILABLE' if not yet booked by a user or the users username.

A staff member in this section can schedule a new date for users to be able to book to. The app asks for a date and checks to see if the date isn't currently in use. If not it adds it to the relevant google sheet and makes it 'AVAILABLE' for users to book a session.

8 As a Staff Member I want to be able to see who has booked for what sessions.

9 As a Staff Member I want to be able to add additional sessions for people to book.

10 As a Staff Member I would like a user to only be able book on certain dates.

12 As a Site Owner I want to be able to validate all of the user input and provide feedback if input is invalid.

13 As a Site Owner I would like users to be able to get back to the welcome screen at any point through the process.

• For all that the app functions and collects the necessary information the user accounts aren't secure. I would like to implement password protection to help resolve this issue.
• The app does validate a lot of the users inputs however there is always room for improvement. I would like to enhance the validation of the dates a user inputs. This would limit further any errors in the data stored.

PEP8 and Pylint have been used to validate all of the python code within the site. All files have passed with 0 errors. Click on the below to see each screenshot: PEP8

1. run.py

   
2. bmi.py

   
3. google_sheet.py

   
4. parq.py

   

Pylint

1. run.py

   
2. bmi.py

   
3. google_sheet.py

   
4. parq.py

   

Screenshot to show user story test 1

Screenshot to show user story test 2

Screenshot to show user story test 1

Screenshot to show user story test 2

Screenshot to show user story test 1

Screenshot to show user story test 2

Screenshot to show user story test 1

Screenshot to show user story test 1

Follows the same test as user story 1

Screenshot to show user story test 1

Follows same test as user story 4

Screenshot to show user story test 1

Screenshot to show user story test 1

Screenshot to show user story test 1

Screenshot to show user story test 1

Follows same test as user story 1

Screenshot to show user story test 1

Screenshot to show user story test 2

Screenshot to show user story test 1

Screenshot to show user story test 1

Screenshot to show user story test 1

• Bug: Not displaying validation message when an unavailable date is being entered
• Fix: Remove not needed else statement and correctly indent print statements
• Bug: Book function has too many vairables for Pylint
• Fix: Split function in half
• Bug: Unnecessary elif in various functions
• Fix: Remove elif and correctly indent code below removed elif
• Bug: validate_username function not working correctly
• Fix: Add missing return value to end of function
• Bug: validate_username only working for one of the calls not both
• Fix: change from using while True to using a try and except which gave flexibilty to service both calls
• Bug: book function not validating the date input
• Fix: add validation missing from function to check date

The steps I took to deploy to Heroku. If you want to do it yourself follow:

1. Create an account at heroku.com
2. Click on new and select create a new app.
3. Add a unique app name and select your region.
4. Click on create app.
5. Click on Settings.
6. Under Config Vars add your sensitive data (I used this for creds.json file) and set an additional to KEY: port VALUE: 8000.
7. I have set buildpacks to and . Must be in that order.
8. Go to Deploy and at Deployment method click on Connect to Github.
9. Enter your repository name and click on it when it shows.
10. Choose the branch you want to buid your app from. I used main for this project.
11. I have used Enable Automatic Deploys which keeps the app up to date with your Github repository

Steps I took to set up the google API. If you want to do it yourself follow:

1. You need a google account. Either Login or create a Google account.
2. Go to https://console.cloud.google.com/
3. Click on the New Project icon.
4. Add Project name and details.
5. Under API's and services enable Google Drive and Sheets. These are the ones I have used but there are more so you can look through the lirbary.
6. Create a credential service account. Maybe different if you use different APIs.
7. Download the credential and upload it to your workspace in a JSON file.
8. Under API's and services enable Google Drive and Sheets (or ones that you are using).
9. Compelete the needed tasks to be performed in the documentation for the Drive and Sheets API.
10. Add them to your code.

• This Stack overflow post for helping with displaying a dictionary as a table in the console
• This post on Real Python for helping with iterating through a dictionary and filtering the values
• This post on geeksforgeeks for helping with converting 2 lists into a dictionary

• To Mo Shami, my mentor, for getting me through this with great advice and support
• To the Code Institute slack community for finding out great advice, guidance and resources.