Release v1.0.1: Replace browser_zone with serp_zone parameter

- Replace browser_zone with serp_zone in bdclient constructor
- Enable serp_zone configuration directly from client
- Add admin permissions requirement in docstring
- Update documentation, examples, and tests
- Version bump to 1.0.1

Author: עידן וילנסקי

CHANGELOG.md

@@ -5,6 +5,16 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.1] - 2025-08-11
+
+### Changed
+- Replaced `browser_zone` parameter with `serp_zone` parameter in `bdclient` constructor
+- `serp_zone` can now be configured directly from the client instead of only via environment variable
+- Updated documentation and tests to reflect the parameter change
+
+### Removed  
+- `browser_zone` parameter from `bdclient` constructor (was unused in the codebase)
+
 ## [1.0.0] - 2024-08-10
 
 ### Added

README.md

@@ -53,7 +53,8 @@ Or you can use a custom zone name
 client = bdclient(
     api_token="your_token",
     auto_create_zones=False,          # Else it creates the Zone automatically
-    web_unlocker_zone="custom_zone",  # Custom zone name (serp_zone for search requests)
+    web_unlocker_zone="custom_zone",  # Custom zone name for web scraping
+    serp_zone="custom_serp_zone"      # Custom zone name for search requests
 )
 ```
 > [!TIP]

brightdata/__init__.py

@@ -32,7 +32,7 @@
     APIError
 )
 
-__version__ = "1.0.0"
+__version__ = "1.0.1"
 __author__ = "Bright Data"
 __email__ = "[email protected]"
 

brightdata/client.py

@@ -8,7 +8,7 @@
 from .utils import ZoneManager, setup_logging, get_logger
 from .exceptions import ValidationError, AuthenticationError, APIError
 
-__version__ = "1.0.0"
+__version__ = "1.0.1"
 
 logger = get_logger('client')
 
@@ -28,7 +28,7 @@ def __init__(
         api_token: str = None,
         auto_create_zones: bool = True,
         web_unlocker_zone: str = None,
-        browser_zone: str = None,
+        serp_zone: str = None,
         log_level: str = "INFO",
         structured_logging: bool = True,
         verbose: bool = None
@@ -37,12 +37,13 @@ def __init__(
         Initialize the Bright Data client with your API token
         
         Create an account at https://brightdata.com/ to get your API token.
+        Go to settings > API keys , and verify that your API key have "Admin" permissions.
 
         Args:
             api_token: Your Bright Data API token (can also be set via BRIGHTDATA_API_TOKEN env var)
             auto_create_zones: Automatically create required zones if they don't exist (default: True)
             web_unlocker_zone: Custom zone name for web unlocker (default: from env or 'sdk_unlocker')
-            browser_zone: Custom zone name for browser API (default: from env or 'sdk_browser')
+            serp_zone: Custom zone name for SERP API (default: from env or 'sdk_serp')
             log_level: Logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL)
             structured_logging: Whether to use structured JSON logging (default: True)
             verbose: Enable verbose logging (default: False). Can also be set via BRIGHTDATA_VERBOSE env var.
@@ -78,8 +79,7 @@ def __init__(
         logger.info(f"API token validated successfully: {token_preview}")
 
         self.web_unlocker_zone = web_unlocker_zone or os.getenv('WEB_UNLOCKER_ZONE', 'sdk_unlocker')
-        self.browser_zone = browser_zone or os.getenv('BROWSER_ZONE', 'sdk_browser')
-        self.serp_zone = os.getenv('SERP_ZONE', 'sdk_serp')
+        self.serp_zone = serp_zone or os.getenv('SERP_ZONE', 'sdk_serp')
         self.auto_create_zones = auto_create_zones
 
         self.session = requests.Session()

examples/search_example.py

@@ -5,7 +5,7 @@
 
 from brightdata import bdclient
 
-client = bdclient(api_token="your-api-token") #can also be taken from .env file
+client = bdclient(api_token="your-api-key",auto_create_zones=False, serp_zone="your-custom-serp-zone") # zone and API token can also be defined in .env file
 
 query = ["iphone 16", "coffee maker", "portable projector", "sony headphones",
         "laptop stand", "power bank", "running shoes", "android tablet",

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "brightdata"
-version = "1.0.0"
+version = "1.0.1"
 description = "Python SDK for Bright Data Web Scraping and SERP APIs"
 authors = [
     {name = "Bright Data", email = "[email protected]"}

tests/test_client.py

@@ -41,7 +41,6 @@ def test_client_zone_defaults(self):
         with patch.dict(os.environ, {}, clear=True):
             client = bdclient(api_token="test_token", auto_create_zones=False)
             assert client.web_unlocker_zone == "sdk_unlocker"
-            assert client.browser_zone == "sdk_browser" 
             assert client.serp_zone == "sdk_serp"
 
     def test_client_custom_zones(self):
@@ -50,11 +49,11 @@ def test_client_custom_zones(self):
             client = bdclient(
                 api_token="test_token",
                 web_unlocker_zone="custom_unlocker",
-                browser_zone="custom_browser",
+                serp_zone="custom_serp",
                 auto_create_zones=False
             )
             assert client.web_unlocker_zone == "custom_unlocker"
-            assert client.browser_zone == "custom_browser"
+            assert client.serp_zone == "custom_serp"
 
 
 class TestClientMethods: