# Chrome Extension Python
`Chrome Extension Python` that allows you to easily integrate Chrome extensions in web automation frameworks like Botasaurus, Selenium, and Playwright.
This tool simplifies the process of downloading, configuring, and using any Chrome extension.
## Installation
Install the package using pip:
```bash
python -m pip install chrome_extension_python
```
## Usage
This package allows the use of Chrome extensions in Botasaurus, Selenium, and Playwright frameworks.
Below are examples demonstrating the integration of the Adblock extension in each framework.
### Usage with Botasaurus
[Botasaurus](https://github.com/omkarcloud/botasaurus), a web scraping framework, integrates easily with `Chrome Extension Python`. Pass the Chrome Webstore link of the extension to use it.
Example with Adblock Extension:
```python
from botasaurus import *
from chrome_extension_python import Extension
@browser(
extensions=[Extension("https://chromewebstore.google.com/detail/adblock-%E2%80%94-best-ad-blocker/gighmmpiobklfepjocnamgkkbiglidom")],
)
def open_chrome(driver: AntiDetectDriver, data):
driver.prompt()
open_chrome()
```
### Usage with Selenium
Integration with Selenium involves setting up Chrome options and adding the extension.
Example:
```python
from selenium import webdriver
from selenium.webdriver.chrome.options import Options
from chromedriver_autoinstaller import install
from chrome_extension_python import Extension
# Set Chrome options
options = Options()
options.add_argument(Extension("https://chromewebstore.google.com/detail/adblock-%E2%80%94-best-ad-blocker/gighmmpiobklfepjocnamgkkbiglidom").load())
# Install and set up the driver
driver_path = install()
driver = webdriver.Chrome(driver_path, options=options)
# Prompt for user input
input("Press Enter to exit...")
# Clean up
driver.quit()
```
### Usage with Playwright
Playwright integration includes specifying the extension path and launching the browser context with the extension.
Example:
```python
from playwright.sync_api import sync_playwright
from chrome_extension_python import Extension
import random
def generate_random_profile():
return str(random.randint(1, 1000))
with sync_playwright() as p:
extension_path = Extension("https://chromewebstore.google.com/detail/adblock-%E2%80%94-best-ad-blocker/gighmmpiobklfepjocnamgkkbiglidom").load(with_command_line_option=False)
browser = p.chromium.launch_persistent_context(
user_data_dir=generate_random_profile(),
headless=False,
args=[
'--disable-extensions-except='+ extension_path,
'--load-extension=' + extension_path,
],
)
page = browser.new_page()
input("Press Enter to exit...")
browser.close()
```
## Configuring an Extension
Extensions can be configured either
- by editing their JavaScript files
- or by interacting with their UI using Selenium.
### Editing JavaScript Files
The JavaScript file editing method is faster and more robust. The following example demonstrates creating a configurable CapSolver Extension with an API key:
```python
from chrome_extension_python import Extension
class Capsolver(Extension):
def __init__(self, api_key):
# Initialize the Capsolver extension with given parameters
super().__init__(
extension_id="pgojnojmmhpofjgdmaebadhbocahppod", # Unique identifier for the Chrome Extension, found in the Chrome Webstore link
extension_name="capsolver", # The name assigned to the extension
api_key=api_key, # An important custom parameter (API key) required for the extension's functionality
)
# This method is called to update the necessary JavaScript files within the extension
def update_files(self, api_key):
# Retrieve a list of all JavaScript files in the extension
js_files = self.get_js_files()
def update_js_contents(content):
# A string in the JavaScript file that needs to be replaced
to_replace = "return e.defaultConfig"
# The new content to insert, which includes the API key
replacement = (
f"return {{ ...e.defaultConfig, apiKey: '{api_key}' }}"
)
# Replace the old string with the new one in the file's content
return content.replace(to_replace, replacement)
# Loop through each JavaScript file and update its contents
for file in js_files:
file.update_contents(update_js_contents)
# Retrieve the specific configuration JavaScript file
config_file = self.get_file("/assets/config.js")
def update_config_contents(content):
# Replace the empty apiKey value with the new API key in the config file
key_replaced = content.replace("apiKey: '',", f"
apiKey: '{api_key}',")
return key_replaced
# Update the config file with the new API key
config_file.update_contents(update_config_contents)
```
Usage Example:
```python
from botasaurus import *
@browser(
extensions=[Capsolver(api_key="CAP-MY_KEY")],
)
def open_chrome(driver: AntiDetectDriver, data):
driver.get("https://recaptcha-demo.appspot.com/recaptcha-v2-checkbox.php")
driver.prompt()
open_chrome()
```
## API Reference
For custom extension development, the following methods are available:
- `get_js_files`, `get_json_files`, `get_html_files`, `get_css_files`: Recursively retrieves specified file types.
- `get_file`: Retrieves a specific file as a `File` object.
- `File.update_contents`: Updates the content of a file.
- `force_update` (defaults to False): Redownload the extension and call `update_files` when extension data changes. It is recommended to set it to `True` during active development.
Example of a custom extension with `force_update`:
```python
from chrome_extension_python import Extension
class CustomExtension(Extension):
def __init__(self, api_key):
# Initialize the CustomExtension with specific parameters
super().__init__(
extension_id="pgojnojmmhpofjgdmaebadhbocahppod", # Unique identifier for the Chrome Extension, obtained from the Chrome Webstore link
extension_name="capsolver", # The name assigned to the extension
force_update=True, # This flag, when set to True, forces the redownload of the extension and calls the `update_files` method. This is useful during development to ensure updates are applied.
)
```
## Examples of Custom Extensions
Here are some code snippets of Custom Extensions to provide you with an idea of how to develop your own.
- [Capsolver Extension](https://github.com/omkarcloud/capsolver-extension-python)
- [2captcha Extension](https://github.com/omkarcloud/2captcha-extension-python)
## Publishing Your Extension
If you wish to share your extension with other developers via PyPI, follow these steps:
1. Clone the template repository: [capsolver-extension-python](https://github.com/omkarcloud/capsolver-extension-python).
2. Replace references to "capsolver" with your extension's name.
3. Rename the `capsolver_extension_python` folder to match your extension name.
4. Insert your extension code in `__init__.py`.
5. Update README.md
6. Use `npm run upload` to publish the extension on PyPI.
Contact us at `chetan@omkar.cloud` with details about your extension. If it's beneficial for web scrapers, we'll promote it within the Botasaurus community.
## Love It? [Star It ⭐!](https://github.com/omkarcloud/chrome-extension-python)
Become one of our amazing stargazers by giving us a star ⭐ on GitHub!
It's just one click, but it means the world to me.
[](https://github.com/omkarcloud/chrome-extension-python/stargazers)
Raw data
{
"_id": null,
"home_page": "https://github.com/omkarcloud/chrome-extension-python",
"name": "chrome-extension-python",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "chrome-extension-python",
"author": "Chetan Jain",
"author_email": "chetan@omkar.cloud",
"download_url": "https://files.pythonhosted.org/packages/df/ec/9efabca89b4af1d456ec10968da069bd6885c5f54b805cc357a693b0e1c3/chrome_extension_python-1.0.1.tar.gz",
"platform": null,
"description": "# Chrome Extension Python\r\n\r\n`Chrome Extension Python` that allows you to easily integrate Chrome extensions in web automation frameworks like Botasaurus, Selenium, and Playwright. \r\n\r\nThis tool simplifies the process of downloading, configuring, and using any Chrome extension.\r\n\r\n## Installation\r\n\r\nInstall the package using pip:\r\n\r\n```bash\r\npython -m pip install chrome_extension_python\r\n```\r\n\r\n## Usage\r\n\r\nThis package allows the use of Chrome extensions in Botasaurus, Selenium, and Playwright frameworks.\r\n\r\nBelow are examples demonstrating the integration of the Adblock extension in each framework.\r\n\r\n### Usage with Botasaurus\r\n\r\n[Botasaurus](https://github.com/omkarcloud/botasaurus), a web scraping framework, integrates easily with `Chrome Extension Python`. Pass the Chrome Webstore link of the extension to use it.\r\n\r\nExample with Adblock Extension:\r\n\r\n```python\r\nfrom botasaurus import *\r\nfrom chrome_extension_python import Extension\r\n\r\n@browser(\r\n extensions=[Extension(\"https://chromewebstore.google.com/detail/adblock-%E2%80%94-best-ad-blocker/gighmmpiobklfepjocnamgkkbiglidom\")], \r\n) \r\ndef open_chrome(driver: AntiDetectDriver, data):\r\n driver.prompt()\r\n\r\nopen_chrome()\r\n```\r\n\r\n### Usage with Selenium\r\n\r\nIntegration with Selenium involves setting up Chrome options and adding the extension.\r\n\r\nExample:\r\n\r\n```python\r\nfrom selenium import webdriver\r\nfrom selenium.webdriver.chrome.options import Options\r\nfrom chromedriver_autoinstaller import install\r\nfrom chrome_extension_python import Extension\r\n\r\n# Set Chrome options\r\noptions = Options()\r\noptions.add_argument(Extension(\"https://chromewebstore.google.com/detail/adblock-%E2%80%94-best-ad-blocker/gighmmpiobklfepjocnamgkkbiglidom\").load())\r\n\r\n# Install and set up the driver\r\ndriver_path = install()\r\ndriver = webdriver.Chrome(driver_path, options=options)\r\n\r\n# Prompt for user input\r\ninput(\"Press Enter to exit...\")\r\n\r\n# Clean up\r\ndriver.quit()\r\n```\r\n\r\n### Usage with Playwright\r\n\r\nPlaywright integration includes specifying the extension path and launching the browser context with the extension.\r\n\r\nExample:\r\n\r\n```python\r\nfrom playwright.sync_api import sync_playwright\r\nfrom chrome_extension_python import Extension\r\nimport random\r\n\r\ndef generate_random_profile():\r\n return str(random.randint(1, 1000))\r\n\r\nwith sync_playwright() as p:\r\n extension_path = Extension(\"https://chromewebstore.google.com/detail/adblock-%E2%80%94-best-ad-blocker/gighmmpiobklfepjocnamgkkbiglidom\").load(with_command_line_option=False)\r\n browser = p.chromium.launch_persistent_context(\r\n user_data_dir=generate_random_profile(),\r\n headless=False,\r\n args=[\r\n '--disable-extensions-except='+ extension_path,\r\n '--load-extension=' + extension_path,\r\n ],\r\n )\r\n page = browser.new_page()\r\n input(\"Press Enter to exit...\")\r\n browser.close()\r\n```\r\n\r\n## Configuring an Extension\r\n\r\nExtensions can be configured either\r\n\r\n- by editing their JavaScript files\r\n- or by interacting with their UI using Selenium.\r\n\r\n### Editing JavaScript Files\r\n\r\nThe JavaScript file editing method is faster and more robust. The following example demonstrates creating a configurable CapSolver Extension with an API key:\r\n\r\n```python\r\nfrom chrome_extension_python import Extension\r\n\r\nclass Capsolver(Extension):\r\n def __init__(self, api_key):\r\n # Initialize the Capsolver extension with given parameters\r\n super().__init__(\r\n extension_id=\"pgojnojmmhpofjgdmaebadhbocahppod\", # Unique identifier for the Chrome Extension, found in the Chrome Webstore link\r\n extension_name=\"capsolver\", # The name assigned to the extension\r\n api_key=api_key, # An important custom parameter (API key) required for the extension's functionality\r\n )\r\n\r\n # This method is called to update the necessary JavaScript files within the extension\r\n def update_files(self, api_key):\r\n # Retrieve a list of all JavaScript files in the extension\r\n js_files = self.get_js_files()\r\n\r\n def update_js_contents(content):\r\n # A string in the JavaScript file that needs to be replaced\r\n to_replace = \"return e.defaultConfig\"\r\n # The new content to insert, which includes the API key\r\n replacement = (\r\n f\"return {{ ...e.defaultConfig, apiKey: '{api_key}' }}\"\r\n )\r\n # Replace the old string with the new one in the file's content\r\n return content.replace(to_replace, replacement)\r\n\r\n # Loop through each JavaScript file and update its contents\r\n for file in js_files:\r\n file.update_contents(update_js_contents)\r\n\r\n # Retrieve the specific configuration JavaScript file\r\n config_file = self.get_file(\"/assets/config.js\")\r\n\r\n def update_config_contents(content):\r\n # Replace the empty apiKey value with the new API key in the config file\r\n key_replaced = content.replace(\"apiKey: '',\", f\"\r\n\r\napiKey: '{api_key}',\")\r\n return key_replaced\r\n\r\n # Update the config file with the new API key\r\n config_file.update_contents(update_config_contents)\r\n```\r\n\r\nUsage Example:\r\n\r\n```python\r\nfrom botasaurus import *\r\n\r\n@browser(\r\n extensions=[Capsolver(api_key=\"CAP-MY_KEY\")],\r\n) \r\ndef open_chrome(driver: AntiDetectDriver, data):\r\n driver.get(\"https://recaptcha-demo.appspot.com/recaptcha-v2-checkbox.php\")\r\n driver.prompt()\r\n\r\nopen_chrome()\r\n```\r\n\r\n## API Reference\r\n\r\nFor custom extension development, the following methods are available:\r\n\r\n- `get_js_files`, `get_json_files`, `get_html_files`, `get_css_files`: Recursively retrieves specified file types.\r\n- `get_file`: Retrieves a specific file as a `File` object.\r\n- `File.update_contents`: Updates the content of a file.\r\n- `force_update` (defaults to False): Redownload the extension and call `update_files` when extension data changes. It is recommended to set it to `True` during active development.\r\n\r\nExample of a custom extension with `force_update`:\r\n\r\n```python\r\nfrom chrome_extension_python import Extension\r\n\r\nclass CustomExtension(Extension):\r\n def __init__(self, api_key):\r\n # Initialize the CustomExtension with specific parameters\r\n super().__init__(\r\n extension_id=\"pgojnojmmhpofjgdmaebadhbocahppod\", # Unique identifier for the Chrome Extension, obtained from the Chrome Webstore link\r\n extension_name=\"capsolver\", # The name assigned to the extension\r\n force_update=True, # This flag, when set to True, forces the redownload of the extension and calls the `update_files` method. This is useful during development to ensure updates are applied.\r\n )\r\n```\r\n\r\n## Examples of Custom Extensions\r\nHere are some code snippets of Custom Extensions to provide you with an idea of how to develop your own.\r\n\r\n- [Capsolver Extension](https://github.com/omkarcloud/capsolver-extension-python)\r\n- [2captcha Extension](https://github.com/omkarcloud/2captcha-extension-python)\r\n\r\n## Publishing Your Extension\r\n\r\nIf you wish to share your extension with other developers via PyPI, follow these steps:\r\n\r\n1. Clone the template repository: [capsolver-extension-python](https://github.com/omkarcloud/capsolver-extension-python).\r\n2. Replace references to \"capsolver\" with your extension's name.\r\n3. Rename the `capsolver_extension_python` folder to match your extension name.\r\n4. Insert your extension code in `__init__.py`.\r\n5. Update README.md\r\n6. Use `npm run upload` to publish the extension on PyPI.\r\n\r\nContact us at `chetan@omkar.cloud` with details about your extension. If it's beneficial for web scrapers, we'll promote it within the Botasaurus community.\r\n\r\n## Love It? [Star It \u2b50!](https://github.com/omkarcloud/chrome-extension-python)\r\n\r\nBecome one of our amazing stargazers by giving us a star \u2b50 on GitHub!\r\n\r\nIt's just one click, but it means the world to me.\r\n\r\n[](https://github.com/omkarcloud/chrome-extension-python/stargazers)\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Chrome Extension Python allows you to easily integrate Chrome extensions in web automation frameworks like Botasaurus, Selenium, and Playwright.",
"version": "1.0.1",
"project_urls": {
"Homepage": "https://github.com/omkarcloud/chrome-extension-python"
},
"split_keywords": [
"chrome-extension-python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dfec9efabca89b4af1d456ec10968da069bd6885c5f54b805cc357a693b0e1c3",
"md5": "95fd5a528e0297fe253e21e9b3b3dbd3",
"sha256": "55a069aa0957250f74a2219d3b97e83fe359502573c3bc4f60f48b062270a28a"
},
"downloads": -1,
"filename": "chrome_extension_python-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "95fd5a528e0297fe253e21e9b3b3dbd3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 7716,
"upload_time": "2024-01-26T11:20:34",
"upload_time_iso_8601": "2024-01-26T11:20:34.499732Z",
"url": "https://files.pythonhosted.org/packages/df/ec/9efabca89b4af1d456ec10968da069bd6885c5f54b805cc357a693b0e1c3/chrome_extension_python-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-26 11:20:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "omkarcloud",
"github_project": "chrome-extension-python",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "chrome-extension-python"
}
JSON
