Project scope

[racheldijkstra]

In this issue the project scope is defined. This includes the objectives and goals, the features and functionalities, the deliverables, the inclusions, the constraints, the assumptions, the dependencies, the acceptance criteria and the risks.

[racheldijkstra]

Objectives and Goals

The objective of this project is to provide a tangible product as part of my portfolio to show in what way I organize my projects and show part of the skills I have.

The tool itself should be able to provide a weekly menu, based on recipes the user likes, their preferred maximum calorie intake, and their preferred macro balances. The goal of this tool is to make it easier to make custom-planned weekly menus based on personal preferences. This is supposed to make sure that dieting does not feel like a punishment anymore, as the user will eat food they like every day of the week.

[racheldijkstra]

Features and Functionalities

The core features that will be implemented in the tool.

• A page where a profile can be selected or added
• A homepage that features the weekmenu and the grocery shopping list that have been made (or still have to be made)
• A page where recipe cards can be viewed and liked
• A favorites page where all liked recipe cards are stored
• A profile page where the name, the profile picture, the preferred maximum calories consumed in a day and the preferred macro balance can be adjusted.
• A page that shows the settings when creating the weekmenu and the order of importance of the user preferrences.

[racheldijkstra]

Deliverables

In this project documentation, source code and a working downloadable software project will be delivered.

[racheldijkstra]

Inclusions and Dependencies

In this section, all specific technologies or tools that will be used for this portfolio project will be mentioned.

Programming language

• Python: As this language is used a lot in the field of data, I am planning on mainly using this language for both the webscraping and the downloadable software application.

Webscraping

• Selenium: This is a python package that is usually used for automated testing, however, in this case it will be mainly used to automate the webscraping and push buttons during that process.
• BeautifulSoup: This is a python package that is used to scrape information from the web through the html source code of that page.

Graphical user interface

• PyQt5: This is a modern UI package that provides bindings with the Qt framework. This allows me to make a GUI for the tool.

Database and storage

• SQLite: This is a lightweight and embedded database that is easy to set up and does not require a dedicated server. It's suitable for smaller applications and is included with python.
• Local file storage: The local file storage will be used to save pictures that will be used in the application.

Packaging and Distribution

• PyInstaller: This tool allows you to package the python application into a stand alone executable for windows. All necessary dependencies and the Python Interpreter will be bundled into a single executable file.

Version control

• Git: For version control and keeping track of the changes in the code github will be used. Git will also be used to safely store the source code of the application online, so that it can be accessed from anywhere.

[racheldijkstra]

Constraints

• No money should be spend on this project
• Python should be used to practice this language further as it is a language used a lot in the world of data.

[racheldijkstra]

Assumptions

• I assume that I learn to efficiently webscrape through this project. This is not a skill I possess at the start of the project.

[racheldijkstra]

Acceptance Criteria

This project can be considered a succes when:

• The application has a responsive design.
• The application is interactive.
• The database connections are made the right way.
• The application is working through one executable file.
• The application can provide the user a weekmenu that fits their needs and preferences.

[racheldijkstra]

Risks

Potential challenges are:

• Learning to efficiently webscrape
• Linking the supermarkt products and their amounts to the ingredients in recipes.