Run accessibility checks on a Pytest sample repo

Clone the sample test repository

Clone the sample Git repository using the following commands.

git clone https://github.com/browserstack/pytest-appium-app-browserstack

Set up the Python virtual environment

Navigate to the sample project directory and create a Python virtual environment.

cd pytest-appium-app-browserstack
python3 -m venv env
source env/bin/activate
pip3 install -r requirements.txt

cd pytest-appium-app-browserstack
python3 -m venv env
.\env\Scripts\Activate.ps1
pip3 install -r requirements.txt

Update the BrowserStack SDK

If you have not already done so, update the BrowserStack SDK to the latest version.

pip install --upgrade browserstack-sdk

Navigate to the platform directory

Based on your testing platform, navigate to the Android or iOS directory.

cd pytest-appium-app-browserstack/android

cd pytest-appium-app-browserstack/ios

Configure the browserstack.yml file

The browserstack.yml file contains the necessary capabilities to run your tests on BrowserStack. It is platform-specific and located in the relevant platform folder (android/ or ios/). Make sure you modify the file that corresponds to your testing platform.

1. Open the browserstack.yml file in an editor.
2. Add your userName and accessKey.
3. Set the accessibility flag to true. The default value is false.
4. Set the framework to pytest.
5. Save the file.

userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
projectName: BrowserStack Samples
buildName: browserstack build
buildIdentifier: '#${BUILD_NUMBER}'
app: ./BStackSampleApp.ipa
framework: pytest
platforms:
  - deviceName: iPhone 14
    osVersion: 16
    platformName: ios
  - deviceName: iPhone 12
    osVersion: 17
    platformName: ios
parallelsPerPlatform: 2
accessibility: true
browserstackLocal: false
debug: false
networkLogs: false
consoleLogs: errors

Run the sample test

In the platform folder, run the following command to execute the sample test.

browserstack-sdk pytest -s bstack_sample.py