https://github.com/robot-runner-community/robot-runner
Robot Runner is a GUI that helps testers to run, and manage auto tests created by robot framework in order to have a good user experience.
https://github.com/robot-runner-community/robot-runner
automated-testing automation ci-cd pyqt6 python qa-automation qt6 robotframework tests
Last synced: 9 days ago
JSON representation
Robot Runner is a GUI that helps testers to run, and manage auto tests created by robot framework in order to have a good user experience.
- Host: GitHub
- URL: https://github.com/robot-runner-community/robot-runner
- Owner: ROBOT-RUNNER-COMMUNITY
- License: apache-2.0
- Created: 2025-03-31T20:08:16.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-04-22T23:41:06.000Z (7 months ago)
- Last Synced: 2025-04-23T15:16:49.942Z (7 months ago)
- Topics: automated-testing, automation, ci-cd, pyqt6, python, qa-automation, qt6, robotframework, tests
- Language: Python
- Homepage:
- Size: 180 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
ROBOT RUNNER
## Table of Contents
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [Prerequisites](#prerequisites)
- [Steps to Install](#steps-to-install)
- [Building the Application](#building-the-application)
- [Steps to Build](#steps-to-build)
- [Building an Executable](#building-an-executable)
- [Steps to Build the Executable using a pre-build script shell](#steps-to-build-the-executable-using-a-pre-build-script-shell)
- [Steps to Build the Executable](#steps-to-build-the-executable)
- [Contributing](#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:
```bash
git clone https://github.com/your-username/robot-runner.git
cd robot-runner
```
2. Create a virtual environment (optional but recommended):
```bash
python -m venv venv
```
3. Activate the virtual environment:
- **Windows**:
```bash
venv\Scripts\activate
```
- **macOS/Linux**:
```bash
source venv/bin/activate
```
4. Install the required dependencies:
```bash
pip install -r requirements.txt
```
5. (Optional) Install Robot Framework and Pabot globally if you don't have them:
```bash
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:
```bash
pip install -r requirements.txt
```
2. Run the application:
You can run the app directly with:
```bash
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:
```bash
sudo apt get bash
bash ./build.sh
```
2. For windows:
```bash
./build.sh
```
### Steps to Build the Executable
1. Install PyInstaller:
```bash
pip install pyinstaller
```
2. Create the executable:
Run the following command in the project root directory to build the .exe file:
```bash
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:
```bash
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**
```bash
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:
```bash
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:
```bash
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:
```bash
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.