Skip to main content

Integrate Your Test Suite with BrowserStack

BrowserStack Python SDK supports a plug-and-play integration. Run your entire test suite in parallel with a few steps!

Select your integration method

  • Automatic (Browserstack SDK)
    Plug-n-play solution that takes care of all the integration steps for you
  • Manual (Language bindings)
    Start and stop the BrowserStack Local tunnel within your test suite manually

Using the BrowserStack SDK is the recommended integration method for Python. The SDK auto-handles your integration steps.

Learn the benefits of using BrowserStack SDK

Following are the benefits of using BrowserStack SDK against manual integration process:

Integration step With BrowserStack SDK With manual integration
Perform Webdriver changes to run tests on BrowserStack Yes Via the browserstack.yml config file Changes Requires code changes to change the RemoteWebdriver
Integrate with BrowserStack Local Yes Via the browserstack.yml config file Changes Requires code changes in test suite
Send test context to BrowserStack for reporting Changes Requires code changes in test suite Changes Requires additional code to be added in the test suite hooks
Use basic cross browser testing parallelization Yes Via the browserstack.yml config file Changes May require code changes depending on the test suite
Use advanced parallelization strategies ChangesRequires code changes to support different parallelisation strategies Changes Requires code changes to support different parallelization strategies

Prerequisites

  • An existing automated test suite.
  • Python3 and Pip3 is installed on your machine.

Looking for a starter project? Get started with our Python sample project.

Integration Steps

Complete the following steps to integrate your test suite using BrowserStack SDK.

Set BrowserStack credentials

Saving your BrowserStack credentials as environment variables makes it simple to run your test suite from your local or CI environment.

Copy icon Copy snippet
Copy icon Copy snippet

Install BrowserStack Python SDK

Execute the following commands to install BrowserStack Python SDK for plug-and-play integration of your test suite with BrowserStack.

Copy icon Copy snippet
Copy icon Copy snippet
Unable to install BrowserStack SDK?

If you can’t install BrowserStack SDK due to sudo privilege issues, create a virtual environment and execute the installation command.

python3 -m venv env
source env/bin/activate
python3 -m pip install browserstack-sdk
browserstack-sdk setup --username "YOUR_USERNAME" --key "YOUR_ACCESS_KEY"
python3 -m venv env
env\Scripts\activate
python3 -m pip install browserstack-sdk
browserstack-sdk setup --username "YOUR_USERNAME" --key "YOUR_ACCESS_KEY"

Update your BrowserStack config file

Once you have installed the SDK, a browserstack.yml config file will be created at the root level of your project. This file contains all the required capabilities to run tests on BrowserStack.

Set platforms to test on

Set the browsers/devices you want to test under the platforms object. Our config follows W3C formatted capabilities.

Parallel thread #1
Parallel thread #2
Parallel thread #3

Enable BrowserStack Local

Test localhost/internal servers in your network

True
False
Test Localhost/Staging websites that are not publicly accessible

BrowserStack Local Testing feature connects with test suites that test your localhost URL

Learn more

If your staging environment is behind a proxy or firewall, additional arguments, such as proxy username, proxy password, etc, must be set. Check out Local Binary parameters to learn about additional arguments or Contact Support for assistance.

Organizing your test suite

Our projectName, buildName, and sessionName capabilities help with organizing your tests on BrowserStack Dashboard.

Build Name
Project Name

Use additional debugging features

By default, BrowserStack provides prettified session logs, screenshots on every failed selenium command, and a video of the entire test. Additionally, you can enable the following features:

Visual logs

Enables screenshots for every selenium command ran

True
False
Network logs

Enables network capture for the session in HAR format. Might reduce session performance slightly

True
False

Update browserstack.yml file with selected capabilities

Copy the following code snippet and replace contents of browserstack.yml file in the root folder of your test suite.

browserstack.yml
Copy icon Copy snippet

Run your test suite

Append browserstack-sdk before your existing run commands to execute your tests on BrowserStack using the Python SDK.

Before
python3 </path-to-test-suite.py>

After
browserstack-sdk python3 </path-to-test-suite.py>

Advanced features and use cases

Here’s a list of features and capabilities you may find useful.

Accept insecure certificates

The acceptInsecureCerts capability suppresses browser popups warning about self-signed certificates usually found in staging environments.

Capability Expected values
acceptInsecureCerts A boolean. Default is False.
True if you want to accept all SSL certificates.
browserstack.yml

Change desktop resolution

The resolution capability changes the default desktop screen resolution for your tests on BrowserStack.

Capability Description Expected values
resolution Set the resolution of your VM before beginning your test A string. Default resolution is 1024x768

Supported resolutions:
Windows (XP, 7): 800x600, 1024x768, 1280x800, 1280x1024, 1366x768, 1440x900, 1680x1050, 1600x1200, 1920x1200, 1920x1080, and 2048x1536

Windows (8, 8.1, 10): 1024x768, 1280x800, 1280x1024, 1366x768, 1440x900, 1680x1050, 1600x1200, 1920x1200, 1920x1080, and 2048x1536

OS X (Ventura, Monterey, Big Sur, Catalina, Mojave, and High Sierra): 1024x768, 1280x960, 1280x1024, 1600x1200, 1920x1080, 2560x1440, 2560x1600, and 3840x2160

OS X (All other versions): 1024x768, 1280x960, 1280x1024, 1600x1200, and 1920x1080
browserstack.yml

Others

Below are few of the additional links to documentation pages that might help with your test scenarios:

Next steps

Once you have successfully integrated your test suite with BrowserStack, you might want to check the following:

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked






Thank you for your valuable feedback

Is this page helping you?

Yes
No

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked






Thank you for your valuable feedback!

Talk to an Expert
Download Copy