Add files via upload

Author: oxyjonas

README.md

@@ -1 +1,68 @@
-# selenium-proxy-integration
+# Oxylabs’ Residential Proxies integration with Selenium
+
+[<img src="https://img.shields.io/static/v1?label=&message=Python&color=brightgreen" />](https://github.com/topics/python) [<img src="https://img.shields.io/static/v1?label=&message=Selenium&color=orange" />](https://github.com/topics/selenium) [<img src="https://img.shields.io/static/v1?label=&message=Web-Scraping&color=yellow" />](https://github.com/topics/web-scraping) [<img src="https://img.shields.io/static/v1?label=&message=Rotating%20Proxies&color=blueviolet" />](https://github.com/topics/rotating-proxies)
+
+## Requirements
+For the integration to work, you'll need to install Selenium on your system. You can do it using `pip` command:
+```bash
+pip install selenium
+```
+Another required package is `webdriver-manager`. It's a package that simplifies the management of binary drivers for different browsers, so you don't need to manually download a new version of a web driver after each update. Visit the [official project directory](https://pypi.org/project/webdriver-manager/) on pypi to find out more information. You can install the following using `pip` as well.
+```bash
+pip install webdriver-manager
+```
+Required version of Python: `Python 3.5` (or higher)
+## Proxy Authentication
+For proxies to work, you'll need to specify your account credentials inside the [main.py](https://github.com/oxylabs/selenium-proxy-integration/blob/main/main.py) file.
+```python
+USERNAME = "your_username"
+PASSWORD = "your_password"
+HOST = "pr.oxylabs.io"
+PORT = 7777
+```
+Adjust the `your_username` and `your_password` fields with the username and password of your Oxylabs account.
+## Country-Specific Entry Node
+If you want, you can also specify the entry node of a specific country:
+```python
+COUNTRY = "US"
+```
+To do that, adjust the `country` variable to any country that Oxylabs support. You can check out our [documentation](https://developers.oxylabs.io/residential-proxies/#country-specific-entry-nodes) for a complete list of country-specific entry nodes.
+
+## Testing Proxy Connection
+You can test proxy connection by visiting https://ip.oxylabs.io/. It will return your current IP address.
+```python
+try:
+    driver.get("https://ip.oxylabs.io/")
+    time.sleep(5)
+finally:
+    driver.close()
+```
+
+## Full Code
+```python
+
+import time
+from selenium import webdriver
+from webdriver_manager.chrome import ChromeDriverManager
+from proxies import chrome_proxy
+
+USERNAME = "your_username"
+PASSWORD = "your_password"
+HOST = "pr.oxylabs.io"
+PORT = 7777
+COUNTRY = "US"
+
+options = webdriver.ChromeOptions()
+proxy_ext = chrome_proxy(USERNAME, PASSWORD, HOST, PORT, COUNTRY)
+options.add_extension(proxy_ext)
+driver = webdriver.Chrome(ChromeDriverManager().install(), options=options)
+
+try:
+    driver.get("https://ip.oxylabs.io/")
+    time.sleep(5)
+finally:
+    driver.close()
+```
+If you're having any trouble integrating proxies with Selenium and this guide didn't help you - feel free to contact Oxylabs customer support at support@oxylabs.io.
+
+

main.py

@@ -0,0 +1,24 @@
+import time
+from selenium import webdriver
+# A package to have a chromedriver always up-to-date.
+from webdriver_manager.chrome import ChromeDriverManager
+from proxies import chrome_proxy
+
+USERNAME = "your_username"
+PASSWORD = "your_password"
+HOST = "pr.oxylabs.io"
+PORT = 7777
+# Specify country code if you want proxies from a single country, e.g. `US`.
+# Otherwise - set the variable to `None`.
+COUNTRY = "US"
+
+options = webdriver.ChromeOptions()
+proxy_ext = chrome_proxy(USERNAME, PASSWORD, HOST, PORT, COUNTRY)
+options.add_extension(proxy_ext)
+driver = webdriver.Chrome(ChromeDriverManager().install(), options=options)
+
+try:
+    driver.get("https://ip.oxylabs.io/")
+    time.sleep(5)
+finally:
+    driver.close()

proxies.py

@@ -0,0 +1,70 @@
+import zipfile
+from typing import Optional
+
+MANIFEST_JSON = """
+    {
+      "version": "1.0.0",
+      "manifest_version": 2,
+      "name": "Oxylabs Selenium Proxy Integration",
+      "permissions": [
+        "proxy",
+        "tabs",
+        "unlimitedStorage",
+        "storage",
+        "<all_urls>",
+        "webRequest",
+        "webRequestBlocking"
+      ],
+      "background": {
+        "scripts": ["background.js"]
+      },
+      "minimum_chrome_version":"22.0.0"
+    }
+    """
+
+BACKGROUND_JS = """
+    var config = {
+      mode: "fixed_servers",
+      rules: {
+        singleProxy: {
+          scheme: "http",
+          host: "%s",
+          port: %d,
+        },
+        bypassList: ["localhost"]
+      }
+    };
+    chrome.proxy.settings.set({value: config, scope: "regular"}, function() {});
+    function callbackFn(details) {
+      return {
+        authCredentials: {
+          username: "customer-%s",
+          password: "%s",
+        }
+      };
+    }
+    chrome.webRequest.onAuthRequired.addListener(
+      callbackFn,
+      {urls: ["<all_urls>"]},
+      ['blocking']
+    );
+"""
+
+
+def chrome_proxy(user: str, password: str, host: str, port: int, country: Optional[str] = None):
+    if country:
+        user = f"{user}-cc-{country}"
+
+    bg = BACKGROUND_JS % (
+        host,
+        port,
+        user,
+        password,
+    )
+
+    ext = "proxy_extension.zip"
+    with zipfile.ZipFile(ext, "w") as zp:
+        zp.writestr("manifest.json", MANIFEST_JSON)
+        zp.writestr("background.js", bg)
+
+    return ext

requirements.txt

@@ -0,0 +1,2 @@
+webdriver-manager
+selenium