anchorbrowser 0.3.11__tar.gz → 0.3.13__tar.gz

anchorbrowser-0.3.13/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.3.13"
+}

{anchorbrowser-0.3.11 → anchorbrowser-0.3.13}/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## 0.3.13 (2025-12-09)
+
+Full Changelog: [v0.3.12...v0.3.13](https://github.com/anchorbrowser/AnchorBrowser-SDK-Python/compare/v0.3.12...v0.3.13)
+
+### Bug Fixes
+
+* **types:** allow pyright to infer TypedDict types within SequenceNotStr ([cb35cbc](https://github.com/anchorbrowser/AnchorBrowser-SDK-Python/commit/cb35cbcfddccb5fee912b1cafe3dfab5b237209f))
+
+
+### Chores
+
+* add missing docstrings ([6e46d9f](https://github.com/anchorbrowser/AnchorBrowser-SDK-Python/commit/6e46d9f28d01af030ea754883f0086cd80705999))
+
+## 0.3.12 (2025-12-03)
+
+Full Changelog: [v0.3.11...v0.3.12](https://github.com/anchorbrowser/AnchorBrowser-SDK-Python/compare/v0.3.11...v0.3.12)
+
+### Chores
+
+* **docs:** use environment variables for authentication in code snippets ([8d13120](https://github.com/anchorbrowser/AnchorBrowser-SDK-Python/commit/8d13120a106de59c11150b731c22056d50df1192))
+* update lockfile ([4d3c63b](https://github.com/anchorbrowser/AnchorBrowser-SDK-Python/commit/4d3c63b11cacbd6e10f2c837c7e25ce9842b7cc2))
+
 ## 0.3.11 (2025-11-28)
 
 Full Changelog: [v0.3.10...v0.3.11](https://github.com/anchorbrowser/AnchorBrowser-SDK-Python/compare/v0.3.10...v0.3.11)

{anchorbrowser-0.3.11 → anchorbrowser-0.3.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: anchorbrowser
-Version: 0.3.11
+Version: 0.3.13
 Summary: The official Python library for the anchorbrowser API
 Project-URL: Homepage, https://github.com/anchorbrowser/AnchorBrowser-SDK-Python
 Project-URL: Repository, https://github.com/anchorbrowser/AnchorBrowser-SDK-Python
@@ -120,6 +120,7 @@ pip install anchorbrowser[aiohttp]
 Then you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:
 
 ```python
+import os
 import asyncio
 from anchorbrowser import DefaultAioHttpClient
 from anchorbrowser import AsyncAnchorbrowser
@@ -127,7 +128,7 @@ from anchorbrowser import AsyncAnchorbrowser
 
 async def main() -> None:
     async with AsyncAnchorbrowser(
-        api_key="Your API Key",
+        api_key=os.environ.get("ANCHORBROWSER_API_KEY"),  # This is the default and can be omitted
         http_client=DefaultAioHttpClient(),
     ) as client:
         session = await client.sessions.create(

{anchorbrowser-0.3.11 → anchorbrowser-0.3.13}/README.md

@@ -83,6 +83,7 @@ pip install anchorbrowser[aiohttp]
 Then you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:
 
 ```python
+import os
 import asyncio
 from anchorbrowser import DefaultAioHttpClient
 from anchorbrowser import AsyncAnchorbrowser
@@ -90,7 +91,7 @@ from anchorbrowser import AsyncAnchorbrowser
 
 async def main() -> None:
     async with AsyncAnchorbrowser(
-        api_key="Your API Key",
+        api_key=os.environ.get("ANCHORBROWSER_API_KEY"),  # This is the default and can be omitted
         http_client=DefaultAioHttpClient(),
     ) as client:
         session = await client.sessions.create(

{anchorbrowser-0.3.11 → anchorbrowser-0.3.13}/pyproject.toml

@@ -1,22 +1,24 @@
 [project]
 name = "anchorbrowser"
-version = "0.3.11"
+version = "0.3.13"
 description = "The official Python library for the anchorbrowser API"
 dynamic = ["readme"]
 license = "Apache-2.0"
 authors = [
 { name = "Anchorbrowser", email = "support@anchorbrowser.io" },
 ]
+
 dependencies = [
     "httpx>=0.28.1",
-    "pydantic>=1.9.0, <3",
+  "pydantic>=1.9.0, <3",
     "typing-extensions>=4.15.0",
-    "anyio>=3.5.0, <5",
-    "distro>=1.7.0, <2",
-    "sniffio",
+  "anyio>=3.5.0, <5",
+  "distro>=1.7.0, <2",
+  "sniffio",
     "websockets>=15.0.1",
     "playwright>=1.55.0",
 ]
+
 requires-python = ">= 3.9"
 classifiers = [
   "Typing :: Typed",

{anchorbrowser-0.3.11 → anchorbrowser-0.3.13}/requirements-dev.lock

@@ -12,40 +12,45 @@
 -e file:.
 aiohappyeyeballs==2.6.1
     # via aiohttp
-aiohttp==3.12.8
+aiohttp==3.13.2
     # via anchorbrowser
     # via httpx-aiohttp
-aiosignal==1.3.2
+aiosignal==1.4.0
     # via aiohttp
-annotated-types==0.6.0
+annotated-types==0.7.0
     # via pydantic
-anyio==4.4.0
+anyio==4.12.0
     # via anchorbrowser
     # via httpx
-argcomplete==3.1.2
+argcomplete==3.6.3
     # via nox
 async-timeout==5.0.1
     # via aiohttp
-attrs==25.3.0
+attrs==25.4.0
     # via aiohttp
-certifi==2023.7.22
+    # via nox
+backports-asyncio-runner==1.2.0
+    # via pytest-asyncio
+certifi==2025.11.12
     # via httpcore
     # via httpx
-colorlog==6.7.0
+colorlog==6.10.1
+    # via nox
+dependency-groups==1.3.1
     # via nox
-dirty-equals==0.6.0
-distlib==0.3.7
+dirty-equals==0.11
+distlib==0.4.0
     # via virtualenv
-distro==1.8.0
+distro==1.9.0
     # via anchorbrowser
-exceptiongroup==1.3.0
+exceptiongroup==1.3.1
     # via anyio
     # via pytest
-execnet==2.1.1
+execnet==2.1.2
     # via pytest-xdist
-filelock==3.12.4
+filelock==3.19.1
     # via virtualenv
-frozenlist==1.6.2
+frozenlist==1.8.0
     # via aiohttp
     # via aiosignal
 greenlet==3.2.4
@@ -60,73 +65,75 @@ httpx==0.28.1
     # via respx
 httpx-aiohttp==0.1.9
     # via anchorbrowser
-idna==3.4
+humanize==4.13.0
+    # via nox
+idna==3.11
     # via anyio
     # via httpx
     # via yarl
-importlib-metadata==7.0.0
-iniconfig==2.0.0
+importlib-metadata==8.7.0
+iniconfig==2.1.0
     # via pytest
 markdown-it-py==3.0.0
     # via rich
 mdurl==0.1.2
     # via markdown-it-py
-multidict==6.4.4
+multidict==6.7.0
     # via aiohttp
     # via yarl
 mypy==1.17.0
-mypy-extensions==1.0.0
+mypy-extensions==1.1.0
     # via mypy
-nodeenv==1.8.0
+nodeenv==1.9.1
     # via pyright
-nox==2023.4.22
-packaging==23.2
+nox==2025.11.12
+packaging==25.0
+    # via dependency-groups
     # via nox
     # via pytest
 pathspec==0.12.1
     # via mypy
-platformdirs==3.11.0
+platformdirs==4.4.0
     # via virtualenv
 playwright==1.55.0
     # via anchorbrowser
-pluggy==1.5.0
+    #via rich
+pluggy==1.6.0
     # via pytest
-propcache==0.3.1
+propcache==0.4.1
     # via aiohttp
     # via yarl
-pydantic==2.11.9
+pydantic==2.12.5
     # via anchorbrowser
-pydantic-core==2.33.2
+pydantic-core==2.41.5
     # via pydantic
 pyee==13.0.0
     # via playwright
-pygments==2.18.0
-    # via rich
+pygments==2.19.2
+    # via pytest
 pyright==1.1.399
-pytest==8.3.3
+pytest==8.4.2
     # via pytest-asyncio
     # via pytest-xdist
-pytest-asyncio==0.24.0
-pytest-xdist==3.7.0
-python-dateutil==2.8.2
+pytest-asyncio==1.2.0
+pytest-xdist==3.8.0
+python-dateutil==2.9.0.post0
     # via time-machine
-pytz==2023.3.post1
-    # via dirty-equals
 respx==0.22.0
-rich==13.7.1
-ruff==0.9.4
-setuptools==68.2.2
-    # via nodeenv
-six==1.16.0
+rich==14.2.0
+ruff==0.14.7
+six==1.17.0
     # via python-dateutil
-sniffio==1.3.0
+sniffio==1.3.1
     # via anchorbrowser
     # via anyio
 time-machine==2.9.0
 tomli==2.3.0
     # via mypy
+    # via nox
     # via pytest
 typing-extensions==4.15.0
+    # via aiosignal
     # via anchorbrowser
     # via anyio
     # via exceptiongroup
@@ -136,14 +143,16 @@ typing-extensions==4.15.0
     # via pydantic-core
     # via pyee
     # via pyright
+    # via pytest-asyncio
     # via typing-inspection
-typing-inspection==0.4.1
+    # via virtualenv
+typing-inspection==0.4.2
     # via pydantic
-virtualenv==20.24.5
+virtualenv==20.35.4
     # via nox
 websockets==15.0.1
     # via anchorbrowser
-yarl==1.20.0
+yarl==1.22.0
     # via aiohttp
-zipp==3.17.0
+zipp==3.23.0
     # via importlib-metadata

{anchorbrowser-0.3.11 → anchorbrowser-0.3.13}/requirements.lock

@@ -12,28 +12,28 @@
 -e file:.
 aiohappyeyeballs==2.6.1
     # via aiohttp
-aiohttp==3.12.8
+aiohttp==3.13.2
     # via anchorbrowser
     # via httpx-aiohttp
-aiosignal==1.3.2
+aiosignal==1.4.0
     # via aiohttp
-annotated-types==0.6.0
+annotated-types==0.7.0
     # via pydantic
-anyio==4.4.0
+anyio==4.12.0
     # via anchorbrowser
     # via httpx
 async-timeout==5.0.1
     # via aiohttp
-attrs==25.3.0
+attrs==25.4.0
     # via aiohttp
-certifi==2023.7.22
+certifi==2025.11.12
     # via httpcore
     # via httpx
-distro==1.8.0
+distro==1.9.0
     # via anchorbrowser
-exceptiongroup==1.3.0
+exceptiongroup==1.3.1
     # via anyio
-frozenlist==1.6.2
+frozenlist==1.8.0
     # via aiohttp
     # via aiosignal
 greenlet==3.2.4
@@ -47,16 +47,16 @@ httpx==0.28.1
     # via httpx-aiohttp
 httpx-aiohttp==0.1.9
     # via anchorbrowser
-idna==3.4
+idna==3.11
     # via anyio
     # via httpx
     # via yarl
-multidict==6.4.4
+multidict==6.7.0
     # via aiohttp
     # via yarl
 playwright==1.55.0
     # via anchorbrowser
-propcache==0.3.1
+propcache==0.4.1
     # via aiohttp
     # via yarl
 pydantic==2.12.5
@@ -65,10 +65,10 @@ pydantic-core==2.41.5
     # via pydantic
 pyee==13.0.0
     # via playwright
-sniffio==1.3.0
+sniffio==1.3.1
     # via anchorbrowser
-    # via anyio
 typing-extensions==4.15.0
+    # via aiosignal
     # via anchorbrowser
     # via anyio
     # via exceptiongroup
@@ -81,5 +81,5 @@ typing-inspection==0.4.2
     # via pydantic
 websockets==15.0.1
     # via anchorbrowser
-yarl==1.20.0
+yarl==1.22.0
     # via aiohttp

{anchorbrowser-0.3.11 → anchorbrowser-0.3.13}/src/anchorbrowser/_types.py

@@ -243,6 +243,9 @@ _T_co = TypeVar("_T_co", covariant=True)
 if TYPE_CHECKING:
     # This works because str.__contains__ does not accept object (either in typeshed or at runtime)
     # https://github.com/hauntsaninja/useful_types/blob/5e9710f3875107d068e7679fd7fec9cfab0eff3b/useful_types/__init__.py#L285
+    #
+    # Note: index() and count() methods are intentionally omitted to allow pyright to properly
+    # infer TypedDict types when dict literals are used in lists assigned to SequenceNotStr.
     class SequenceNotStr(Protocol[_T_co]):
         @overload
         def __getitem__(self, index: SupportsIndex, /) -> _T_co: ...
@@ -251,8 +254,6 @@ if TYPE_CHECKING:
         def __contains__(self, value: object, /) -> bool: ...
         def __len__(self) -> int: ...
         def __iter__(self) -> Iterator[_T_co]: ...
-        def index(self, value: Any, start: int = 0, stop: int = ..., /) -> int: ...
-        def count(self, value: Any, /) -> int: ...
         def __reversed__(self) -> Iterator[_T_co]: ...
 else:
     # just point this to a normal `Sequence` at runtime to avoid having to special case

{anchorbrowser-0.3.11 → anchorbrowser-0.3.13}/src/anchorbrowser/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "anchorbrowser"
-__version__ = "0.3.11"  # x-release-please-version
+__version__ = "0.3.13"  # x-release-please-version

{anchorbrowser-0.3.11 → anchorbrowser-0.3.13}/src/anchorbrowser/types/batch_session_create_params.py

@@ -47,11 +47,15 @@ class BatchSessionCreateParams(TypedDict, total=False):
 
 
 class ConfigurationBrowserAdblock(TypedDict, total=False):
+    """Configuration for ad-blocking."""
+
     active: bool
     """Enable or disable ad-blocking. Defaults to `true`."""
 
 
 class ConfigurationBrowserCaptchaSolver(TypedDict, total=False):
+    """Configuration for captcha-solving."""
+
     active: bool
     """Enable or disable captcha-solving.
 
@@ -60,6 +64,8 @@ class ConfigurationBrowserCaptchaSolver(TypedDict, total=False):
 
 
 class ConfigurationBrowserDisableWebSecurity(TypedDict, total=False):
+    """Configuration for disabling web security features."""
+
     active: bool
     """Whether to disable web security features (CORS, same-origin policy, etc.).
 
@@ -69,11 +75,17 @@ class ConfigurationBrowserDisableWebSecurity(TypedDict, total=False):
 
 
 class ConfigurationBrowserExtraStealth(TypedDict, total=False):
+    """
+    Configuration for extra stealth mode to enhance browser fingerprinting protection.
+    """
+
     active: bool
     """Enable or disable extra stealth mode."""
 
 
 class ConfigurationBrowserFullscreen(TypedDict, total=False):
+    """Configuration for fullscreen mode."""
+
     active: bool
     """Enable or disable fullscreen mode.
 
@@ -82,11 +94,15 @@ class ConfigurationBrowserFullscreen(TypedDict, total=False):
 
 
 class ConfigurationBrowserHeadless(TypedDict, total=False):
+    """Configuration for headless mode."""
+
     active: bool
     """Whether browser should be headless or headful. Defaults to `false`."""
 
 
 class ConfigurationBrowserP2pDownload(TypedDict, total=False):
+    """Configuration for peer-to-peer download capture functionality."""
+
     active: bool
     """Enable or disable P2P downloads.
 
@@ -96,6 +112,8 @@ class ConfigurationBrowserP2pDownload(TypedDict, total=False):
 
 
 class ConfigurationBrowserPopupBlocker(TypedDict, total=False):
+    """Configuration for popup blocking."""
+
     active: bool
     """Blocks popups, including ads and CAPTCHA consent banners.
 
@@ -104,6 +122,8 @@ class ConfigurationBrowserPopupBlocker(TypedDict, total=False):
 
 
 class ConfigurationBrowserProfile(TypedDict, total=False):
+    """Options for managing and persisting browser session profiles."""
+
     name: str
     """The name of the profile to be used during the browser session."""
 
@@ -115,6 +135,8 @@ class ConfigurationBrowserProfile(TypedDict, total=False):
 
 
 class ConfigurationBrowserViewport(TypedDict, total=False):
+    """Configuration for the browser's viewport size."""
+
     height: int
     """Height of the viewport in pixels. Defaults to `900`."""
 
@@ -123,6 +145,8 @@ class ConfigurationBrowserViewport(TypedDict, total=False):
 
 
 class ConfigurationBrowser(TypedDict, total=False):
+    """Browser-specific configurations."""
+
     adblock: ConfigurationBrowserAdblock
     """Configuration for ad-blocking."""
 
@@ -193,6 +217,8 @@ class ConfigurationIntegration(TypedDict, total=False):
 
 
 class ConfigurationSessionLiveView(TypedDict, total=False):
+    """Configuration for live viewing the browser session."""
+
     read_only: bool
     """Enable or disable read-only mode for live viewing. Defaults to `false`."""
 
@@ -435,11 +461,15 @@ ConfigurationSessionProxy: TypeAlias = Union[ConfigurationSessionProxyAnchorProx
 
 
 class ConfigurationSessionRecording(TypedDict, total=False):
+    """Configuration for session recording."""
+
     active: bool
     """Enable or disable video recording of the browser session. Defaults to `true`."""
 
 
 class ConfigurationSessionTimeout(TypedDict, total=False):
+    """Timeout configurations for the browser session."""
+
     idle_timeout: int
     """
     The amount of time (in minutes) the browser session waits for new connections
@@ -454,6 +484,8 @@ class ConfigurationSessionTimeout(TypedDict, total=False):
 
 
 class ConfigurationSession(TypedDict, total=False):
+    """Session-related configurations."""
+
     initial_url: str
     """The URL to navigate to when the browser session starts.
 
@@ -474,6 +506,8 @@ class ConfigurationSession(TypedDict, total=False):
 
 
 class Configuration(TypedDict, total=False):
+    """Configuration that applies to all sessions in the batch"""
+
     browser: ConfigurationBrowser
     """Browser-specific configurations."""
 

{anchorbrowser-0.3.11 → anchorbrowser-0.3.13}/src/anchorbrowser/types/session_create_params.py

@@ -49,11 +49,15 @@ class SessionCreateParams(TypedDict, total=False):
 
 
 class BrowserAdblock(TypedDict, total=False):
+    """Configuration for ad-blocking."""
+
     active: bool
     """Enable or disable ad-blocking. Defaults to `true`."""
 
 
 class BrowserCaptchaSolver(TypedDict, total=False):
+    """Configuration for captcha-solving."""
+
     active: bool
     """Enable or disable captcha-solving.
 
@@ -62,6 +66,8 @@ class BrowserCaptchaSolver(TypedDict, total=False):
 
 
 class BrowserDisableWebSecurity(TypedDict, total=False):
+    """Configuration for disabling web security features."""
+
     active: bool
     """Whether to disable web security features (CORS, same-origin policy, etc.).
 
@@ -71,11 +77,17 @@ class BrowserDisableWebSecurity(TypedDict, total=False):
 
 
 class BrowserExtraStealth(TypedDict, total=False):
+    """
+    Configuration for extra stealth mode to enhance browser fingerprinting protection.
+    """
+
     active: bool
     """Enable or disable extra stealth mode."""
 
 
 class BrowserFullscreen(TypedDict, total=False):
+    """Configuration for fullscreen mode."""
+
     active: bool
     """Enable or disable fullscreen mode.
 
@@ -84,11 +96,15 @@ class BrowserFullscreen(TypedDict, total=False):
 
 
 class BrowserHeadless(TypedDict, total=False):
+    """Configuration for headless mode."""
+
     active: bool
     """Whether browser should be headless or headful. Defaults to `false`."""
 
 
 class BrowserP2pDownload(TypedDict, total=False):
+    """Configuration for peer-to-peer download capture functionality."""
+
     active: bool
     """Enable or disable P2P downloads.
 
@@ -98,6 +114,8 @@ class BrowserP2pDownload(TypedDict, total=False):
 
 
 class BrowserPopupBlocker(TypedDict, total=False):
+    """Configuration for popup blocking."""
+
     active: bool
     """Blocks popups, including ads and CAPTCHA consent banners.
 
@@ -106,6 +124,8 @@ class BrowserPopupBlocker(TypedDict, total=False):
 
 
 class BrowserProfile(TypedDict, total=False):
+    """Options for managing and persisting browser session profiles."""
+
     name: str
     """The name of the profile to be used during the browser session."""
 
@@ -117,6 +137,8 @@ class BrowserProfile(TypedDict, total=False):
 
 
 class BrowserViewport(TypedDict, total=False):
+    """Configuration for the browser's viewport size."""
+
     height: int
     """Height of the viewport in pixels. Defaults to `900`."""
 
@@ -125,6 +147,8 @@ class BrowserViewport(TypedDict, total=False):
 
 
 class Browser(TypedDict, total=False):
+    """Browser-specific configurations."""
+
     adblock: BrowserAdblock
     """Configuration for ad-blocking."""
 
@@ -194,6 +218,8 @@ class Integration(TypedDict, total=False):
 
 
 class SessionLiveView(TypedDict, total=False):
+    """Configuration for live viewing the browser session."""
+
     read_only: bool
     """Enable or disable read-only mode for live viewing. Defaults to `false`."""
 
@@ -437,11 +463,15 @@ SessionProxy: TypeAlias = Union[SessionProxyAnchorProxy, SessionProxyCustomProxy
 
 
 class SessionRecording(TypedDict, total=False):
+    """Configuration for session recording."""
+
     active: bool
     """Enable or disable video recording of the browser session. Defaults to `true`."""
 
 
 class SessionTimeout(TypedDict, total=False):
+    """Timeout configurations for the browser session."""
+
     idle_timeout: int
     """
     The amount of time (in minutes) the browser session waits for new connections
@@ -456,6 +486,8 @@ class SessionTimeout(TypedDict, total=False):
 
 
 class Session(TypedDict, total=False):
+    """Session-related configurations."""
+
     initial_url: str
     """The URL to navigate to when the browser session starts.
 

{anchorbrowser-0.3.11 → anchorbrowser-0.3.13}/src/anchorbrowser/types/task_create_params.py

@@ -37,6 +37,8 @@ class TaskCreateParams(TypedDict, total=False):
 
 
 class BrowserConfigurationLiveView(TypedDict, total=False):
+    """Configuration for live viewing the browser session."""
+
     read_only: bool
     """Enable or disable read-only mode for live viewing. Defaults to `false`."""
 
@@ -279,11 +281,15 @@ BrowserConfigurationProxy: TypeAlias = Union[BrowserConfigurationProxyAnchorProx
 
 
 class BrowserConfigurationRecording(TypedDict, total=False):
+    """Configuration for session recording."""
+
     active: bool
     """Enable or disable video recording of the browser session. Defaults to `true`."""
 
 
 class BrowserConfigurationTimeout(TypedDict, total=False):
+    """Timeout configurations for the browser session."""
+
     idle_timeout: int
     """
     The amount of time (in minutes) the browser session waits for new connections
@@ -298,6 +304,8 @@ class BrowserConfigurationTimeout(TypedDict, total=False):
 
 
 class BrowserConfiguration(TypedDict, total=False):
+    """Browser configuration for task execution"""
+
     initial_url: str
     """The URL to navigate to when the browser session starts.