Skip to content

🛠️ Installation & Setup

Standardized deployment and integration workflows for Python environments.


Setting up the QA Hub Framework in your project is a straightforward process. The framework is designed to be easily integrated into any Python-based test automation project (specifically those using Behave).

📋 Prerequisites

  • Python 3.8+
  • pip (Python package installer)
  • Git (for remote installation)

🚀 Installation via pip

The most common way to include the framework is by adding it as a dependency in your requirements.txt file or installing it directly via pip.

Direct Installation

pip install git+https://github.com/carlos-camara/qa-hub-framework.git#egg=qa-automation-framework

In requirements.txt

Add the following line to your project's requirements.txt:

-e git+https://github.com/carlos-camara/qa-hub-framework.git#egg=qa-automation-framework
Then run:
pip install -r requirements.txt

🛠️ Configuration

The framework uses a centralized configuration system.

  1. Create a features/config/config.yaml file in your project:
    Driver:
      type: chrome
      headless: true
    
  2. (Optional) Create a .env file for secrets.

For full details, see the Configuration Guide.

⚙️ Initial Configuration

Once installed, you must tell Behave where to find the step definitions. In your project's environment.py (or individual step files), import the desired components:

# Import all common components
from qa_framework.steps.api_steps import *
from qa_framework.steps.gui_steps import *
from qa_framework.steps.pdf_steps import *
from qa_framework.steps.common_steps import *

Selective Imports

If your project only performs API testing, you only need to import api_steps. This keeps your step registry clean and fast.