--- title: Pylenium example to be used with TestingBot description: Pylenium - Bring the best of Selenium, Cypress and Python into one package. source_url: html: https://testingbot.com/support/web-automate/selenium/python/pylenium md: https://testingbot.com/support/web-automate/selenium/python/pylenium/index.md --- # Pylenium Pylenium is a Python package, its mission: "Bring the best of Selenium, Cypress and Python into one package." To get started, please make sure you have **python3** installed. Then install the package and scaffold the project: pip install pyleniumio pylenium init `pylenium init` creates a `pylenium.json` config file and a `conftest.py` in your project. ## Example test Pylenium tests use the `py` fixture that ships with the package. Save the example as `test_sample.py`: def test_sample(py): py.visit("https://www.google.com") py.get("[name='q']").type("TestingBot") assert "Google" in py.title Run it with pytest: pytest test_sample.py ## Specify Browsers & Devices Point Pylenium at the TestingBot grid by editing `pylenium.json`. Set `driver.remote_url` to the TestingBot hub and put the W3C capabilities under `driver.capabilities`: { "driver": { "browser": "chrome", "remote_url": "https://API_KEY:API_SECRET@hub.testingbot.com/wd/hub", "capabilities": { "browserVersion": "latest", "platformName": "WIN11", "tb:options": { "name": "Pylenium Test" } } } } Run the same test command, Pylenium now provisions the browser on TestingBot: pytest test_sample.py To use a different browser, version or platform on the fly, override capabilities from the CLI: pytest --remote_url='https://API_KEY:API_SECRET@hub.testingbot.com/wd/hub' Pick a browser/version/platform combination below, the snippet shows the JSON fragment to drop under `driver.capabilities` in `pylenium.json`. ![OS selected](https://testingbot.com/assets/environments/svg/windows11-0e1b28bc0fdd5034d3e4d3dc8d346c500a8c6522facf4b45d0da56537c1f1c6d.svg) Windows 11 › ![Browser Selected](https://testingbot.com/assets/environments/svg/chrome-c4081ff447d2d898d4afcb8f074a907c960e6f007716c1a1d119eee6803c4042.svg) Chrome 139 Loading environments... Please wait while we load the available browsers and platforms. ## Testing Internal Websites We've built [TestingBot Tunnel](https://testingbot.com/support/tunnel), to provide you with a secure way to run tests against your staged/internal webapps. Please see our [TestingBot Tunnel documentation](https://testingbot.com/support/tunnel) for more information about this easy to use tunneling solution. The example below shows how to easily run a Pylenium Python test with our Tunnel: 1. [Download our tunnel](https://testingbot.com/support/tunnel) and start the tunnel: java -jar testingbot-tunnel.jar key secret 2. Adjust your test: instead of pointing to `'hub.testingbot.com/wd/hub'` like the example above - change it to point to your tunnel's IP address. Assuming you run the tunnel on the same machine you run your tests, change to `'localhost:4445/wd/hub'`. localhost is the machine running the tunnel, 4445 is the default port of the tunnel. This way your test will go securely through the tunnel to TestingBot and back. Point Pylenium at the local tunnel URL in `pylenium.json`: { "driver": { "browser": "chrome", "remote_url": "http://localhost:4445/wd/hub", "capabilities": { "browserVersion": "latest", "platformName": "WIN11", "tb:options": { "name": "Pylenium Tunnel Test" } } } } ## Other Options We offer many other [test options](https://testingbot.com/support/web-automate/selenium/test-options), for example: disable video recording, specifying a custom Firefox Profile, loading Chrome/Firefox/Safari extensions, running an executable before your test starts, uploading files, ... See our [list of test options](https://testingbot.com/support/web-automate/selenium/test-options) for a full list of options to customize your tests. ## Run tests in Parallel Parallel Testing means running the same test, or multiple tests, simultaneously. This greatly reduces your total testing time. You can run the same tests on all different browser configurations or run different tests all on the same browser configuration. TestingBot has a large grid of machines and browsers, which means you can use our service to do efficient parallel testing. It is one of the key features we provide to greatly cut down on your total testing time. To run tests in parallel, we recommend using pytest with pytest-xdist, which makes it very easy to run multiple Python tests simultaneously: pip install pytest pytest-xdist pytest -n 4 # run tests on 4 parallel workers ### Queuing Every plan we provide comes with a limit of parallel tests. If you exceed the number of parallel tests assigned to your account, TestingBot will queue the additional tests (for up to 6 minutes) and run the tests as soon as slots become available. ## Mark tests as passed/failed As TestingBot has no way to determine whether your test passed or failed (it is determined by your business logic), we offer a way to send the test status back to TestingBot. This is useful if you want to see if a test succeeded or failed from the TestingBot member area. You can use our [Python API client](https://github.com/testingbot/testingbotclient) to report back test results. Pylenium exposes the underlying Selenium WebDriver via `py.webdriver`, so the session id is available as `py.webdriver.session_id`: from testingbotclient import TestingBotClient def test_sample(py): py.visit("https://www.google.com") passed = "Google" in py.title client = TestingBotClient('API_KEY', 'API_SECRET') client.tests.update_test( py.webdriver.session_id, name='My Test', passed=passed, build='build-123' ) assert passed ## Other Python Framework examples - [PyTest](https://testingbot.com/support/web-automate/selenium/python/pytest) PyTest makes it easy to run Selenium tests with Python. - [Behave](https://testingbot.com/support/web-automate/selenium/python/behave) Behave is behaviour-driven development, Python style. - [Lettuce](https://testingbot.com/support/web-automate/selenium/python/lettuce) Lettuce is a Python BDD plugin based on Ruby's Cucumber, offering Gherkin stories. - [PyUnit](https://testingbot.com/support/web-automate/selenium/python/pyunit) PyUnit is the standard unit testing framework module for Python, described as a Python version of JUnit. - [Pylenium](https://testingbot.com/support/web-automate/selenium/python/pylenium) Pylenium brings the best of Selenium, Cypress and Python into one package. - [Helium](https://testingbot.com/support/web-automate/selenium/python/helium) Helium is a tool that makes it easy to test websites and automate browsers. - [Robot Framework](https://testingbot.com/support/web-automate/selenium/robotframework) Robot Framework is a generic automation framework for acceptance testing. ### Looking for more help? Have questions or need more information? Reach out via email or Slack. [Email us](https://testingbot.com/contact/new)[Slack Join our Slack](https://join.slack.com/t/testingb0t/shared_invite/zt-3bcw9xch-jk19~6XPs_xBrsAgAedkCw)