F223635_F223708_SQE_Project

Table of Contents

1. Introduction
2. Features
3. Installation
4. Usage
5. Testing
6. Project Structure

---

Introduction

This project, developed as part of the Software Quality Engineering (SQE) course, focuses on implementing a robust software solution with integrated testing strategies. The project ensures code quality and performance through a variety of automated testing techniques.

Features

• Core functionality implemented in Python.
• Unit tests using Pytest.
• Data pipeline tests for functionality validation.
• Modular design for easy extension and maintenance.

Installation

Prerequisites

• Python 3.8.0+
• Dependencies listed in requirements.txt.

Steps

1. Clone the repository:

   git clone https://github.com/<your-username>/F223635_F223708_SQE_Project.git

2. Navigate to the project directory:

   cd F223635_F223708_SQE_Project

3. Install dependencies:

   pip install -r requirements.txt

Usage

1. Run the main functionality:

   python source/functions.py

2. To modify or add functionality, update files in the source/ directory.

Testing

Run All Tests

Use Pytest to execute all tests:

pytest

Testing Modules

• Data Pipeline Tests: Located in the data_pipeline_tests/ directory, these validate the data processing workflows.
• Unit Tests: Found in the tests/ directory, covering feature-specific and parameterized test cases.

Example to run specific tests:

pytest tests/test_functions.py

Project Structure

F223635_F223708_SQE_Project/
│
├── README.md               # Project documentation
├── source/                 # Core functionality
│   ├── functions.py        # Main script
│   ├── Product.xlsx        # Supporting data file
│   └── __init__.py         # Module initialization
│
├── tests/                  # Unit tests
│   ├── test_functionas_features.py
│   ├── test_functionas_parametrized.py
│   └── test_functions.py
│
├── data_pipeline_tests/    # Data pipeline tests
│   └── test_pipeline_data_core.py
│
├── .git/                   # Git repository metadata
├── .idea/                  # IDE configuration files
├── .pytest_cache/          # Pytest cache
│
└── requirements.txt        # Project dependencies (if applicable)