This application is a Python-based calculator designed for The Cleaning Hack, a real business. It generates free cleaning estimates for potential clients.
Users are required to enter their full name, mobile number, and email address, which are validated before they can proceed to input details needed for the estimate, such as the number of bedrooms, bathrooms, living spaces and, any other rooms.
These details are also validated before being uploaded to a Google Worksheet, which the business owner uses to initiate follow-up actions with the client.
- Project Planning
- Features
- Future Features
- Technology used
- Testing
- Bugs
- Deployment
- Credits
- Content
- Acknowledgements
For my third portfolio project, I aimed to address a real need, hence the idea to create a cleaning estimate calculator for The Cleaning Hack, an active cleaning business.
After discussing with the business owner and identifying a gap in their internal processes, particularly in automating cleaning estimates and lead tracking, I was confident in my decision.
As the owner, I want to provide automated quotes to prospects.
As the owner, I want prospects to have transparency on pricing prior to booking.
As the owner, I want to save resources by automating a quote without going to the property.
As the owner, I want authorised staff to follow up efficiently with a readily available quote.
As the owner, I want all quotes provided to be automatically saved to a secure file.
Using Lucid Chart, I created a flow diagram to help visualise the steps and logic needed to make the project design and execution as efficient as possible.
See flow chart below for a visual of initial design and concept.
-
Full Name
-
Mobile Number
-
Email Address
This information, once captured, feeds into the business owner's lead generation and management system.
-
No. of Bedrooms
-
No. of Bathrooms
-
No. of Living Areas i.e. Frontroom, Kitchen
-
Other Rooms i.e. Conservatory, Utility
This information is valuable to the business owner as it helps predict the duration of a job so resources such as materials, equipment and labour can be allocated accordingly.
When the user loads the program, they are presented with a welcome message and instructions on how to interact with the program.
Simultaneaously, the user will be prompted to enter their full name, mobile number and email address, which will be validated before they can proceed to the next step. See below:
If validation fails at this stage, the user will see the corresponding error message(s) based on the specific issue. The following images illustrate attempts to submit an alphanumeric name, an incorrect mobile number (fewer than 11 digits), and an incorrect email format. See below:
If validation passes, the user will be prompted to provide the number of bedrooms, bathrooms, living areas / receptions and any other rooms. See below:
If validation fails, the user will see an error message and then be prompted to re-enter information on number of bedrooms, bathrooms, living areas / receptions and any other rooms. See below:
If validation is successful, the user will see a summary of their entry along with a cleaning estimate.
Additionally, the user will be asked to enter "Y" if they would like to obtain a new estimate or any other key to exit the program. See below:
If the user requests a new estimate, they will be again be prompted to provide number of bedrooms, bathrooms, living areas / receptions and any other rooms. See below:
If the user chooses to exit the program, they will see an exit message as shown below:
See below sample data successfully uploaded to worksheet.
-
Functionality to prompt the user to re-enter only the specific data that fails validation.
-
Functionality to accept only UK numbers as valid.
Used to create the application.
Used to deploy and host the terminal application.
Used to store the code.
IDE used for creating the application.
Used for version control.
Used to securely store user contact and property details.
| Test | Result |
|---|---|
| On run program, the welcome message and instructions appear | Pass |
| After instructions, user is prompted for their full name | Pass |
| Once name is input user is prompted for mobile number | Pass |
| Once mobile number is input, user is prompted for email address | Pass |
| Feedback message shows with further instructions on how to enter property details | Pass |
| After instructions, user is prompted for no. of bedrooms | Pass |
| Once no. of bedrooms is input, user is prompted for no. of bathrooms | Pass |
| Once no. of bathrooms is input, user is prompted for no. of livingrooms | Pass |
| Once no. of livingrooms is input, user is prompted for other rooms | Pass |
| Once no. of other rooms is input, feedback message is displayed with estimate | Pass |
| User is then asked if they want to obtain another quote or exit program | Pass |
| If user selects obtain another quote, user is again prompted to enter new property details | Pass |
| Once new property details have been entered, user is provided with new estimate | Pass |
| If user selects exit program, user is shown exit message and program ends | Pass |
The following tests are on error handling throughout the project. If the error handling works as expected it will be marked as pass. If the error handling does not work as expected it will be marked as fail.
Enter Name
- Error Msg1: Invalid Name: Must not be blank!
- Error Msg2: Invalid Name: Min 2 characters and letters only!
- Error Msg3: Invalid Name: {part} not accepted!
| Test | Result |
|---|---|
| User tried to enter a name of less than two characters | Pass |
| User tried to enter a hyphenated name | Fail |
| User tried to enter an empty string | Pass |
| User tried to enter a name with a space in it | Pass |
| User tried to enter an alphanumeric name | Pass |
Enter Mobile Number
- Error Msg: Invalid Number: Must be 11 digits. Please try again.
| Test | Result |
|---|---|
| User tried to enter a number less than 11 digits | Pass |
| User tried to enter a letter | Pass |
| User tried to enter an empty selection | Pass |
| User tried to enter a symbol | Pass |
| User tried to enter a special character | Pass |
Enter Email Address
- Error Msg: Various messages predefined in the 'email_validator' package import.
| Test | Result |
|---|---|
| User tried to enter email without @ symbol | Pass |
| User tried to enter email without domain | Pass |
| User tried to enter an empty string | Pass |
| User tried to enter email without preceeding name before @ symbol | Pass |
| User tried to enter a special character | Pass |
Enter Property Details Error Msg: Invalid Data: You entered 'x'. Enter only numbers OR "0" if not applicable.
| Test | Result |
|---|---|
| User tried to enter a letter | Pass |
| User tried to enter an empty string | Pass |
| User tried to enter a special character | Pass |
| User tried to enter a mix of letters and numbers | Pass |
I used the Pep8 checker tool to validate my python code to ensure it was free from errors as shown here:
To maintain a line length of 79 characters, I had to extensively recode and restructure the program.
Feedback Message - Details Accepted
-
Unable to get sequence of notification messages in email validation function working. Feedback displayed when email is invalid but not when all details have been entered correctly.
- Fixed this by moving the feedback message from update_worksheet to get_user_details.
Validation - User Name Field
-
Unable to get validation to stop users entering numbers in name field.
- Fixed this by switching from try and except statements to if and print statements.
-
Unable to get validation to accept spaces in name field.
- Fixed this by adjusting to request user inputs their full name, as preferred by The Cleaning Hack owner.
Validation - Property Details
-
Unable to handle exceptions for special characters or alphabets in number of rooms fields.
- Fixed this by adopting Code Institute's Love Sandwiches data validation code using try and except statements to convert string input to integers.
Validation - User Name Field
- Unable to get name validation code to allow hyphenated names.
To deploy the project to Heroku, I followed the steps outlined below:
-
Prepare run.py file by adding a new line character ("\n") at the end of the text inside all input methods.
-
Create list of requirements necessary for program to run on heroku by typing "pip3 freeze > requirements.txt" into the command line.
-
Navigate to heroku.com and log in.
-
Click "New" to create a new App.
-
Assign name to application, choose region and Click 'Create New App'.
-
On the next page click on the 'Settings' tab to adjust settings.
-
Click on the 'Config Vars' button.
-
Supply a 'KEY' of "CREDS" and 'Value' of contents of creds.json file. Then click the 'Add' button.
-
Supply a 'KEY' of "PORT" and 'Value' of "8000". Then click the 'Add' button.
-
Add buildpacks to install future dependencies needed outside of the requirements file.
-
Select 'Python' then 'Node.js' and click 'Save' - Make sure they are in this order.
-
Navigate to the deploy section and choose deployment method.
-
To connect with github select 'Github' and confirm.
-
Search for repository, select it and click 'Connect'.
-
To deploy, choose one of the following options:
-
Automatic deploys - meaning Heroku will rebuild the app everytime a new change is pushed.
- For this option, choose the branch to deploy and click 'Enable automatic deploys'.
- This can be changed to manual deployment at a later stage.
-
Manual deployment - which deploys current state of branch.
-
Click 'Deploy branch'.
-
Click 'Open App' to launch application.
Multiple resources used to better understand the logic and flow of functions and capabilities of Python.
Useful for learning how to validate email addresses and led to the import of an email_validator package.
A robust email address syntax validation library installed for use in this project.
Useful for adding ANSI escape character sequences to add color to terminal text.
Useful guide by Sogo Ogundowole on GSpread: Automate Google Sheet with Python. Helped broaden my understanding of GSpread methods and applications.
Useful guide for adding styles to text in terminal.
Useful for resolving name validation issues encountered when using try and except statements. Provided better understanding of various methods of name input validation using if-else statements.
Used to reference Python Structure and play around with code ideas prior to including them in my project.
Project created in line with course content and within project 3 scope.
Used to review my own code to ensure simplicity where possible, and to navigate complexity where unavoidable.
Online publishing platform with distraction-free access to insightful articles by other Software Developers on specific topics.
My mentor who provided me with great feedback and guidance at the inception of this project, helping to keep at the forefront the requirements for a successful project.
Other software developers who gave feedback on their experience whilst interacting with The Cleaning Hack Calculator.
Special thanks to my family for supporting with user testing and providing feedback on flow and experience.