ROBOT RUNNER

Key Features Download Credits

Table of Contents

• Table of Contents
• Installation
  • Prerequisites
  • Steps to Install
• Building the Application
  • Steps to Build
• Building an Executable
  • Steps to Build the Executable using a pre-build script shell
  • Steps to Build the Executable
• Contributing

Installation

Prerequisites

Before you can run or contribute to the project, ensure you have the following installed:

• Python (version 3.6+)
• pip (Python package installer)
• Robot Framework
• PyQt6 (for GUI)
• pabot (optional, for parallel test execution)

Steps to Install

1. Clone the repository:

   git clone https://github.com/your-username/robot-runner.git
   cd robot-runner

2. Create a virtual environment (optional but recommended):

   python -m venv venv

3. Activate the virtual environment:

   • Windows:

     venv\Scripts\activate

   • macOS/Linux:

     source venv/bin/activate

4. Install the required dependencies:

   pip install -r requirements.txt

5. (Optional) Install Robot Framework and Pabot globally if you don't have them:

   pip install robotframework
   pip install pabot

Building the Application

If you'd like to modify and build the application from source, follow these steps.

Steps to Build

1. Install the required dependencies:

   Run the following command to ensure all dependencies are installed:

   pip install -r requirements.txt

2. Run the application:

   You can run the app directly with:

   python main.py

Building an Executable

If you need to distribute the application to users without requiring them to install Python, you can build a standalone .exe file (for Windows) using PyInstaller.

Steps to Build the Executable using a pre-build script shell

In order to generate the executable exe file you just need to run the script :

1. For Linux:

   sudo apt get bash
   bash ./build.sh

2. For windows:

   ./build.sh

Steps to Build the Executable

1. Install PyInstaller:

   pip install pyinstaller

2. Create the executable:

   Run the following command in the project root directory to build the .exe file:

   pyinstaller --onefile --windowed main.py

   • --onefile: Bundles everything into a single executable file.
   • --windowed: Prevents a command prompt window from appearing when you run the app (for GUI apps).

   After building, you can find the .exe file in the dist folder.

3. (Optional) If you want to package the .exe with additional resources (e.g., icons, images), you can modify the PyInstaller command to include them:

   pyinstaller --onefile --windowed --add-data "./style/style.qss;style" --add-data "images/*;images" main.py

   Make sure to adjust paths as needed for your project structure.

Contributing

We welcome contributions! Here’s how you can get involved:

1. Fork the Repository
   Visit the repository and click the Fork button at the top-right of the page to create your own copy of the repository.

2. Clone Your Fork

   git clone https://github.com/ROBOT-RUNNER-COMMUNITY/ROBOT-RUNNER
   cd robot-runner
   

3. Create a Branch
   It’s best to create a new branch for the feature or bug fix you want to work on:

   git checkout -b feature/your-feature

4. Make Your Changes
   Modify the code or add features. Be sure to write tests to validate your changes (if applicable).

5. Commit Your Changes
   Commit your changes with a descriptive message:

   git add .
   git commit -m "Add new feature or fix bug"

6. Push to Your Fork
   Push your changes back to your fork on GitHub:

   git push origin feature/your-feature

7. Open a Pull Request
   Once your changes are pushed, go to the GitHub page for your fork and create a pull request. Provide a clear description of what your changes do and why.

8. Review and Merge
   After the pull request is reviewed, we will merge it into the main branch.