🍊Introduction
Intro for Handshake
Last updated
Intro for Handshake
Last updated
Welcome to Handshake Docs! 📔
Through the rest of the document, you will:
Gain a thorough understanding of Handshake service and how to integrate your Test framework with this Test Reporter.
You will or might Appreciate the elegance of its beautiful reports. 😊
So, Handshake is a program that would process your Automation Test Reports be it for Testing CLI Applications or GUI, web, etc... if they allow a custom reporter to be created. we can channel its data to this program which would transform it to a format that we can understand easily.
So even if you have multiple Automation frameworks set up if a custom reporter exists for the handshake, it can generate reports in the same place.
To set up Handshake, you would need to install our handshake (python-build), if you are already familiar with the build.
Before setting up a reporter specific to your framework configuration, please complete these general setup steps:
Download Python, either version 3.11or the latest 3.12 from python. org-downloads
Setup Virtual Environment is recommended so that your global packages will not be affected., Guide: docs.python.org-creating-virtual-environments
python -m venv [your-env-name]
Activate Venv.
On Windows: [venv-path]\Scripts\activate
On Unix or MacOS: source [venv-path]/bin/activate
pip install handshake
To ensure everything's set up correctly, try running handshake v in your terminal. You should see a message like this:
Output: handshake, version 0.3.8, DB: 7
Activating Venv is necessary to connect with Handshake. Always run your tests in a terminal where this Venv is activated
Versions below Python 3.11 will cause compatibility issues.
And there you have it! 🚀
The rest of the installation process is framework-specific. You can find the detailed steps for your specific framework on the next page.