Easiest zero-config selenium webdriver for Python
Project description
open-webdriver
The simplest and easiest way to get a selenium webdriver
Platform Unit Tests
Platform binary nuitka build
About
Yet another selenium webdriver wrapper API in python, with the aims of being the easist to use with only two lines of code to get running.
Unlike other selenium web driver wrappers, this one is well tested on Windows10/MacOS/Ubuntu platforms.
One function is provided, open_webdriver(...)
which takes care of downloading, installing and then running selenium.
Additionally, sane defaults are set, such as headless by default and ssl certs turned off. This code is also tested and examples are provided for use with the nuitka cross compiler, which allows you to create an binary executable. This is great for distributing a compiled binary for Windows/MacOS/Ubuntu of your selenium bot with all original source code removed, making it impossible to reverse engineer.
open-webdriver
is essentially a wrapper around the very excellent https://pypi.org/project/webdriver-manager/ library, but with the following changes/fixes:
os.environ['WDM_LOCAL'] = '1'
os.environ['WDM_SSL_VERIFY'] = '0'
And other sensible platform specific fixes are applied in order for the selenium driver stack to pass the test suite.
When your app is launched, there will be a side folder name .wdm
which contain the download of the webdriver used. The disk cache for the driver is set for 1 day, after which it will be checked for a new version.
Benefits:
- Production ready. Cross platform tests.
- ssl certs are turned off to reduce errors for many websites.
- Downloading the proper binary for your platform and stashing it next to the app.
- Headless by default.
- Intelligently forces headless in a linux environment without a display card (prevents crash).
- Platform tests to ensure a stable cross platform experience.
- Pins to a specific version of selenium driver stack to ensure reproducable behavior.
- Nuitka Binary Builds for all platforms are tested.
Downsides:
- Only chrome is supported right now. Firefox is experimental and is flaky on some tests/platforms. Open to pull requests if you fix this.
Install
python -m pip install open-webdriver
Api
from open_webdriver import open_webdriver
with open_webdriver() as driver:
driver.get("https://www.google.com")
assert driver.title == "Google"
Tests
Dev:
Just simply run tox
at the command line and everything should be tested. You may need to install tox
with python -m pip tox
.
Package Test:
Run open_webdriver_tests
for package tests. This is useful if you are on a server and want to figure out if open_webdriver will be able to be run in
headless mode using the chrome
driver.
Nuitka
This package supports the Nuitka cross compiler to binary app. However to make this work YOU MUST include the package data for selenium or you will get errors about missing javascript files when the program loads. To get around this you'll need to add package data:
python -m nuitka --include-package-data=selenium ...
For example see the example build file: https://github.com/zackees/open-webdriver/blob/main/tests/nuitka/test_binary_build.py
Pull Requests
Pull requests are welcome for this code base. When you submit your pull request you will need to have the following:
- New code must have a unit/test.
- Must pass the linting requirements. Run
tox
(also run on your pull request).
Changes
- 1.1.12: Fixes bugs for
open_webdriver_test
cmd - 1.1.10: Adds package test
open_webdriver_test
cmd - 1.1.9: Moves tests into package to allow running tests from package.
- 1.1.8: Minor fixes
- 1.1.7: Nit readme.
- 1.1.6: Fixes failing win-tox tests due to missing "PROGRAMW6432" value in os.environ (?!). Brave browser removed as it actually didn't work.
- 1.1.5: Cert warnings now suppressable with non headless sessions.
- 1.1.3: Suppress more cert warnings.
- 1.1.2: Suppress certificate warnings.
- 1.1.1: Update readme.
- 1.1.0: Platform binary builds using nuitka are now tested.
- 1.0.4: Now pins dependencies.
- 1.0.0: Initial code submit.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file open_webdriver-1.1.12.tar.gz
.
File metadata
- Download URL: open_webdriver-1.1.12.tar.gz
- Upload date:
- Size: 8.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.9.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2f3f1957bfb09c9bd7bdbe4c480a5716ea23f285188d94d3d0cd52876e4f53dd |
|
MD5 | 3d383dad437fa4d9d64bd612c4bd8e0e |
|
BLAKE2b-256 | a2c536eb9789e124a7fe65de7960ec49d7fc5ca300faec7e0b5cda723c97dfba |
File details
Details for the file open_webdriver-1.1.12-py2.py3-none-any.whl
.
File metadata
- Download URL: open_webdriver-1.1.12-py2.py3-none-any.whl
- Upload date:
- Size: 8.1 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.9.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 551397fd95b8a6aa13b2451549853fec9d1993fadebcb0075bd108e570a2e0ac |
|
MD5 | 7bbe90827cbfab2045547dcfded0132c |
|
BLAKE2b-256 | 4293630bd248fd2e1a44d286b02f98521125ea7734c0ea9b7199e8f43c742abf |