Environment setup

This section will guide you through the process of setting up your machine for local development

Quick Start (Automated Installation)

The easiest way to get started is using the automated installation script. This will set up your entire environment automatically.

One-line installation:

curl -fsSL https://raw.githubusercontent.com/qltyautomation/QLTYFramework/main/install.sh | bash -s -- --repo YOUR_TEST_REPO_URL

Replace YOUR_TEST_REPO_URL with your test repository URL (e.g., https://github.com/yourorg/yourproject.git)

What the script does:

  • Installs Python 3 and Node.js (if not already installed)

  • Sets up virtualenv and virtualenvwrapper

  • Creates and activates a virtual environment

  • Clones your test repository

  • Installs all dependencies (QLTY Framework + requirements)

  • Configures your environment

Local installation script:

If your test repository already has an install.sh file, you can run it directly:

cd /path/to/your/test/repo
chmod +x install.sh
./install.sh

Note

After installation, you’ll need to configure your local_settings.py file with your API keys and credentials. See the SETUP.md file in your test repository for details.

Manual Installation

If you prefer to set up your environment manually, follow these steps:

  1. Install python 3 through homebrew
    brew install python3

    It is recommended to use homebrew as it will create the required system links too

  2. Install node through homebrew
    brew install node
  3. Install python virtual environment manager
    pip3 install virtualenv

    Virtual environment manager helps us separate python installations and their dependencies

  4. Install python virtual environment wrapper
    pip3 install virtualenvwrapper
  5. Add virtual environment configuration variables

    Edit your .bash_profile or .zshrc depending on which terminal you use and add the following environment variables:

    export WORKON_HOME=~/.virtualenvs
export VIRTUALENVWRAPPER_PYTHON=/usr/local/bin/python3
source /usr/local/bin/virtualenvwrapper.sh
  6. Reopen your terminal or recompile your bash profile
    source ~/.zshrc
  7. Create a virtual environment for the project
    mkvirtualenv qlty-myproject --python=python3
  8. Activate your virtual environment
    workon qlty-myproject

    Make sure that you always work on your virtual environment

  9. Clone your test repository
    git clone YOUR_TEST_REPO_URL
cd YOUR_TEST_REPO
  10. From the root directory of your test repo, install the requirements
    pip3 install -r requirements.txt

    Warning

    You need to have your SSH keys added to your GitHub account if using SSH URLs. Please follow this guide on how to add your SSH keys to your GitHub account

  11. Configure your local settings
    cp local_settings.py.example local_settings.py

    Then edit local_settings.py and add your API keys and credentials

  12. Install Appium with node package manager
    npm install -g appium

Appium installation

Please refer to Appium - Getting started for the latest version on how to install and setup your machine for Appium If you want to validate your installation you can use appium-doctor as shown here Appium doctor.

Android studio installation

You will require a working installation of Android studio in order to use android emulators and real devices.

You can get the latest android studio version here.

Xcode installation

If you are going to work with iOS simulators, real devices or safari mobile you need to install Xcode on you machine.

Xcode gets installed through the Mac App store, here is the link.