Metadata-Version: 2.1
Name: webdriver-manager
Version: 4.1.2
Summary: Library provides the way to automatically manage drivers for different browsers
Author-email: Sergey Pirogov <automationremarks@gmail.com>
License: Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the NOTICE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           APPENDIX: How to apply the Apache License to your work.
        
              To apply the Apache License to your work, attach the following
              boilerplate notice, with the fields enclosed by brackets "{}"
              replaced with your own identifying information. (Don't include
              the brackets!)  The text should be enclosed in the appropriate
              comment syntax for the file format. We also recommend that a
              file or class name and description of purpose be included on the
              same "printed page" as the copyright notice for easier
              identification within third-party archives.
        
           Copyright {yyyy} {name of copyright owner}
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
        
Project-URL: Homepage, https://github.com/SergeyPirogov/webdriver_manager
Project-URL: Repository, https://github.com/SergeyPirogov/webdriver_manager
Keywords: testing,selenium,driver,test automation
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests
Requires-Dist: python-dotenv
Requires-Dist: packaging

# Webdriver Manager for Python

[![Tests](https://github.com/SergeyPirogov/webdriver_manager/actions/workflows/test.yml/badge.svg)](https://github.com/SergeyPirogov/webdriver_manager/actions/workflows/test.yml)
[![PyPI](https://img.shields.io/pypi/v/webdriver-manager.svg)](https://pypi.org/project/webdriver-manager/)
[![Supported Python Versions](https://img.shields.io/pypi/pyversions/webdriver-manager.svg)](https://pypi.org/project/webdriver-manager/)
[![codecov](https://codecov.io/gh/SergeyPirogov/webdriver_manager/branch/master/graph/badge.svg)](https://codecov.io/gh/SergeyPirogov/webdriver_manager)

`webdriver-manager` is a Python library for explicit browser driver management.

It helps download, resolve, cache, and reuse driver binaries for browser automation with Selenium. Instead of downloading a driver manually, unpacking it, and hardcoding a path, you can install the required driver directly from Python code.

> **Note**
>
> For most modern Selenium 4.6+ projects, Selenium Manager is the recommended default. It is built into Selenium and can manage drivers automatically for standard Chrome, Firefox, and Edge setups.
>
> Use `webdriver-manager` when you need explicit control over driver versions, driver paths, cache behavior, download sources, or compatibility with older Selenium versions.

## When should I use webdriver-manager?

Use `webdriver-manager` when Selenium Manager is not enough or when you want to manage drivers explicitly from Python code.

Typical use cases include:

- supporting Selenium 3 or older Selenium 4 projects;
- getting the driver binary path directly;
- pinning or resolving a specific driver version;
- pre-downloading drivers in CI or Docker images;
- customizing cache location or cache invalidation;
- using custom download URLs or mirrors;
- working around corporate proxy, SSL, or restricted network environments;
- using alternative Chromium-based browsers such as Chromium or Brave;
- customizing OS or architecture detection;
- debugging driver resolution and download behavior explicitly.

If your code works with plain Selenium:

```python
from selenium import webdriver

driver = webdriver.Chrome()
```

you probably do not need `webdriver-manager`.

If you need more control over how drivers are resolved, downloaded, cached, or reused, `webdriver-manager` can still be useful.

### Selenium Manager vs webdriver-manager

Selenium Manager is automatic and integrated into Selenium. It is usually the best choice for new Selenium 4.6+ projects with standard browser setups.

`webdriver-manager` is explicit and configurable. It is useful when you want to manage driver resolution yourself, integrate driver installation into your own Python code, or support environments where Selenium Manager is not enough or not desired.

In short:

- use Selenium Manager by default;
- use `webdriver-manager` when you need explicit control.

## Supported drivers

`webdriver-manager` currently supports:

- [ChromeDriver](#use-with-chrome)
- [EdgeChromiumDriver](#use-with-edge)
- [GeckoDriver](#use-with-firefox)
- [IEDriver](#use-with-internet-explorer)
- [OperaDriver](#use-with-opera)

The library is compatible with Selenium 4.x and older Selenium versions.

## Installation

```bash
pip install webdriver-manager
```

Package name:

```text
webdriver-manager
```

Import name:

```python
import webdriver_manager
```

## Environment scope

`webdriver-manager` manages desktop browser drivers for Windows, macOS, and Linux desktop runtimes.

It is not intended for Android or PyDroid local browser automation. For Android automation, use Appium with UiAutomator2 and Chrome/WebView on a device or emulator.

## Usage

### Use with Chrome

#### Selenium 4

```python
from selenium import webdriver
from selenium.webdriver.chrome.service import Service as ChromeService
from webdriver_manager.chrome import ChromeDriverManager

service = ChromeService(ChromeDriverManager().install())
driver = webdriver.Chrome(service=service)
```

#### Selenium 3

```python
from selenium import webdriver
from webdriver_manager.chrome import ChromeDriverManager

driver = webdriver.Chrome(ChromeDriverManager().install())
```

### Use with Chromium

#### Selenium 4

```python
from selenium import webdriver
from selenium.webdriver.chrome.service import Service as ChromiumService
from webdriver_manager.chrome import ChromeDriverManager
from webdriver_manager.core.os_manager import ChromeType

options = webdriver.ChromeOptions()
options.binary_location = "/usr/bin/chromium"

service = ChromiumService(
    ChromeDriverManager(chrome_type=ChromeType.CHROMIUM).install()
)

driver = webdriver.Chrome(service=service, options=options)
```

#### Selenium 3

```python
from selenium import webdriver
from webdriver_manager.chrome import ChromeDriverManager
from webdriver_manager.core.os_manager import ChromeType

options = webdriver.ChromeOptions()
options.binary_location = "/usr/bin/chromium"

driver = webdriver.Chrome(
    ChromeDriverManager(chrome_type=ChromeType.CHROMIUM).install(),
    options=options,
)
```

On macOS, the Chromium binary path may look like this:

```text
/Applications/Chromium.app/Contents/MacOS/Chromium
```

### Use with Brave

#### Selenium 4

```python
from selenium import webdriver
from selenium.webdriver.chrome.service import Service as BraveService
from webdriver_manager.chrome import ChromeDriverManager
from webdriver_manager.core.os_manager import ChromeType

service = BraveService(
    ChromeDriverManager(chrome_type=ChromeType.BRAVE).install()
)

driver = webdriver.Chrome(service=service)
```

#### Selenium 3

```python
from selenium import webdriver
from webdriver_manager.chrome import ChromeDriverManager
from webdriver_manager.core.os_manager import ChromeType

driver = webdriver.Chrome(
    ChromeDriverManager(chrome_type=ChromeType.BRAVE).install()
)
```

### Use with Edge

#### Selenium 4

```python
from selenium import webdriver
from selenium.webdriver.edge.service import Service as EdgeService
from webdriver_manager.microsoft import EdgeChromiumDriverManager

service = EdgeService(EdgeChromiumDriverManager().install())
driver = webdriver.Edge(service=service)
```

#### Selenium 3

```python
from selenium import webdriver
from webdriver_manager.microsoft import EdgeChromiumDriverManager

driver = webdriver.Edge(EdgeChromiumDriverManager().install())
```

### Use with Firefox

#### Selenium 4

```python
from selenium import webdriver
from selenium.webdriver.firefox.service import Service as FirefoxService
from webdriver_manager.firefox import GeckoDriverManager

service = FirefoxService(GeckoDriverManager().install())
driver = webdriver.Firefox(service=service)
```

#### Selenium 3

```python
from selenium import webdriver
from webdriver_manager.firefox import GeckoDriverManager

driver = webdriver.Firefox(executable_path=GeckoDriverManager().install())
```

### Use with Internet Explorer

> **Note**
>
> Internet Explorer support is provided for legacy environments.

#### Selenium 4

```python
from selenium import webdriver
from selenium.webdriver.ie.service import Service as IEService
from webdriver_manager.microsoft import IEDriverManager

service = IEService(IEDriverManager().install())
driver = webdriver.Ie(service=service)
```

#### Selenium 3

```python
from selenium import webdriver
from webdriver_manager.microsoft import IEDriverManager

driver = webdriver.Ie(IEDriverManager().install())
```

### Use with Opera

> **Note**
>
> OperaDriver support is provided for compatibility with existing setups.

#### Selenium 4

```python
from selenium import webdriver
from selenium.webdriver.chrome import service
from webdriver_manager.opera import OperaDriverManager

webdriver_service = service.Service(OperaDriverManager().install())
webdriver_service.start()

options = webdriver.ChromeOptions()
options.add_experimental_option("w3c", True)

driver = webdriver.Remote(webdriver_service.service_url, options=options)
```

#### Selenium 3

```python
from selenium import webdriver
from selenium.webdriver.chrome import service
from webdriver_manager.opera import OperaDriverManager

webdriver_service = service.Service(OperaDriverManager().install())
webdriver_service.start()

driver = webdriver.Remote(
    webdriver_service.service_url,
    webdriver.DesiredCapabilities.OPERA,
)
```

If Opera is installed in a non-standard location, specify the browser binary path:

```python
options = webdriver.ChromeOptions()
options.binary_location = "path/to/opera"

driver = webdriver.Remote(webdriver_service.service_url, options=options)
```

## Configuration

`webdriver-manager` can be configured with environment variables, constructor arguments, or custom manager classes.

### `GH_TOKEN`

Some drivers are downloaded from official GitHub repositories. GitHub limits unauthenticated API requests, so you may need a GitHub token to avoid rate-limit errors.

Set the token as an environment variable:

```bash
export GH_TOKEN="your_token"
```

Or set it from Python:

```python
import os

os.environ["GH_TOKEN"] = "your_token"
```

### `WDM_LOG`

Disable `webdriver-manager` logs:

```python
import logging
import os

os.environ["WDM_LOG"] = str(logging.NOTSET)
```

### `WDM_LOCAL`

By default, driver binaries are saved to the user-level `.wdm` cache directory.

You can store binaries in the project root instead:

```python
import os

os.environ["WDM_LOCAL"] = "1"
```

This is often useful in Docker and CI environments where home-directory permissions are restricted.

You can also pass a custom writable cache location through `DriverCacheManager(root_dir=...)`.

### `WDM_SSL_VERIFY`

SSL verification can be disabled when downloading driver binaries:

```python
import os

os.environ["WDM_SSL_VERIFY"] = "0"
```

Use this only when required by your environment, for example with corporate SSL inspection or custom certificate chains.

### Driver version

You can request a specific driver version:

```python
from webdriver_manager.chrome import ChromeDriverManager

ChromeDriverManager(driver_version="2.26").install()
```

### Cache validity

By default, the driver cache is valid for 1 day.

You can change the cache validity range:

```python
from webdriver_manager.chrome import ChromeDriverManager
from webdriver_manager.core.driver_cache import DriverCacheManager

cache_manager = DriverCacheManager(valid_range=7)

ChromeDriverManager(cache_manager=cache_manager).install()
```

### Custom OS or architecture

You can override OS or architecture detection:

```python
from webdriver_manager.chrome import ChromeDriverManager
from webdriver_manager.core.os_manager import OperationSystemManager

os_manager = OperationSystemManager(os_type="linux-mips64")

ChromeDriverManager(os_system_manager=os_manager).install()
```

### Custom download URL

You can use a custom driver repository or mirror:

```python
from webdriver_manager.chrome import ChromeDriverManager

ChromeDriverManager(
    url="https://custom-repo.example.com",
    latest_release_url="https://custom-repo.example.com/LATEST",
).install()
```

### Get browser version from path

You can detect a browser version from its executable and use that version to resolve a driver:

```python
from webdriver_manager.chrome import ChromeDriverManager
from webdriver_manager.core.os_manager import PATTERN
from webdriver_manager.core.utils import read_version_from_cmd

browser_version = read_version_from_cmd(
    "/usr/bin/google-chrome --version",
    PATTERN["chrome"],
)

driver_path = ChromeDriverManager(driver_version=browser_version).install()
```

### Custom cache, file manager, and OS manager

You can customize cache, file, and OS behavior:

```python
from webdriver_manager.chrome import ChromeDriverManager
from webdriver_manager.core.driver_cache import DriverCacheManager
from webdriver_manager.core.file_manager import FileManager
from webdriver_manager.core.os_manager import OperationSystemManager

os_manager = OperationSystemManager(os_type="win64")
file_manager = FileManager(os_system_manager=os_manager)
cache_manager = DriverCacheManager(file_manager=file_manager)

manager = ChromeDriverManager(cache_manager=cache_manager)
driver_path = manager.install()
```

### Custom logger

You can configure a custom logger with `set_logger()`:

```python
import logging

from webdriver_manager.core.logger import set_logger

logger = logging.getLogger("webdriver_manager")
logger.setLevel(logging.DEBUG)

logger.addHandler(logging.StreamHandler())
logger.addHandler(logging.FileHandler("webdriver_manager.log"))

set_logger(logger)
```

### Custom HTTP client

You can provide a custom HTTP client for advanced network behavior such as custom sessions, proxies, authentication, or retries.

```python
import os

import requests
from requests import Response

from webdriver_manager.chrome import ChromeDriverManager
from webdriver_manager.core.download_manager import WDMDownloadManager
from webdriver_manager.core.http import HttpClient
from webdriver_manager.core.logger import log


class CustomHttpClient(HttpClient):
    def get(self, url, params=None, **kwargs) -> Response:
        log("Downloading driver with a custom HTTP client")
        return requests.get(url, params=params, **kwargs)


http_client = CustomHttpClient()
download_manager = WDMDownloadManager(http_client)

driver_path = ChromeDriverManager(download_manager=download_manager).install()

assert os.path.exists(driver_path)
```

## CI and Docker recommendations

For CI and Docker environments:

- prefer a writable cache directory;
- use `WDM_LOCAL=1` when project-local caching is easier than user-level caching;
- set `GH_TOKEN` if your workflow may hit GitHub API rate limits;
- consider pre-downloading drivers during the image build or CI setup phase;
- pin driver or browser versions when reproducibility is more important than automatic updates.

Example:

```bash
export WDM_LOCAL=1
export GH_TOKEN="your_token"
```

## Reporting issues

When reporting a bug, include:

- operating system and architecture;
- Python version;
- Selenium version;
- `webdriver-manager` version;
- browser name and version;
- full traceback;
- minimal reproducible example;
- whether the issue happens locally, in CI, or in Docker.

Clear reproduction steps make driver-resolution and cache-related issues much easier to investigate.

## Contributing

Bug fixes, compatibility fixes, CI improvements, documentation updates, and regression tests are welcome.

For larger changes, please open an issue first to discuss the proposed approach.

Maintainers: see [RELEASING.md](RELEASING.md) for the release runbook.

## Maintenance status

The project accepts maintenance contributions focused on:

- browser and driver compatibility;
- cache and download reliability;
- CI stability;
- documentation quality;
- regression tests;
- compatibility with supported Selenium versions.

Large feature changes should be discussed before implementation.

## License

See the repository license for details.
