tzafon 2.0.0__tar.gz → 2.1.0__tar.gz

tzafon-2.1.0/.release-please-manifest.json

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

{tzafon-2.0.0 → tzafon-2.1.0}/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## 2.1.0 (2025-10-30)
+
+Full Changelog: [v2.0.1...v2.1.0](https://github.com/tzafon/computer-python/compare/v2.0.1...v2.1.0)
+
+### Features
+
+* **api:** api update ([2a38a7f](https://github.com/tzafon/computer-python/commit/2a38a7f2bb027dd6cd627df075d0c8c4399e615d))
+
+
+### Bug Fixes
+
+* **client:** close streams without requiring full consumption ([24a5a11](https://github.com/tzafon/computer-python/commit/24a5a114bcb3d3d4ed0c0b5df158e09c99d78a79))
+
+## 2.0.1 (2025-10-21)
+
+Full Changelog: [v2.0.0...v2.0.1](https://github.com/tzafon/computer-python/compare/v2.0.0...v2.0.1)
+
 ## 2.0.0 (2025-10-20)
 
 Full Changelog: [v1.4.0...v2.0.0](https://github.com/tzafon/computer-python/compare/v1.4.0...v2.0.0)

{tzafon-2.0.0 → tzafon-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: tzafon
-Version: 2.0.0
+Version: 2.1.0
 Summary: The official Python library for the computer API
 Project-URL: Homepage, https://github.com/tzafon/computer-python
 Project-URL: Repository, https://github.com/tzafon/computer-python
@@ -33,20 +33,22 @@ Requires-Dist: aiohttp; extra == 'aiohttp'
 Requires-Dist: httpx-aiohttp>=0.1.9; extra == 'aiohttp'
 Description-Content-Type: text/markdown
 
-# Computer Python API library
+# Tzafon Python SDK
 
 <!-- prettier-ignore -->
 [![PyPI version](https://img.shields.io/pypi/v/tzafon.svg?label=pypi%20(stable))](https://pypi.org/project/tzafon/)
 
-The Computer Python library provides convenient access to the Computer REST API from any Python 3.8+
-application. The library includes type definitions for all request params and response fields,
-and offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).
+The Tzafon Python SDK provides programmatic control of Chromium browsers and Linux desktop environments. Automate web interactions with simple method calls - navigate, click, type, and capture screenshots.
 
-It is generated with [Stainless](https://www.stainless.com/).
+**Key Features:**
+- Browser and desktop automation
+- Synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx)
+- Type-safe API with full type definitions
+- Context manager support for automatic cleanup
 
 ## Documentation
 
-The REST API documentation can be found on [docs.tzafon.ai](http://docs.tzafon.ai). The full API of this library can be found in [api.md](https://github.com/tzafon/computer-python/tree/main/api.md).
+The REST API documentation can be found at [docs.tzafon.ai](https://docs.tzafon.ai). The full API of this library can be found in [api.md](https://github.com/tzafon/computer-python/tree/main/api.md).
 
 ## Installation
 
@@ -57,53 +59,47 @@ pip install tzafon
 
 ## Usage
 
-The full API of this library can be found in [api.md](https://github.com/tzafon/computer-python/tree/main/api.md).
-
 ```python
-import os
 from tzafon import Computer
 
-client = Computer(
-    api_key=os.environ.get("TZAFON_API_KEY"),  # This is the default and can be omitted
-)
+client = Computer()  # Reads TZAFON_API_KEY from environment
 
-computer_response = client.computers.create(
-    kind="browser",
-)
-print(computer_response.id)
+# Create and control a browser instance
+with client.create(kind="browser") as computer:
+    computer.navigate("https://google.com")
+    computer.type("Tzafon AI")
+    computer.click(100, 200)
+    screenshot = computer.screenshot()
+```
+
+The client automatically reads `TZAFON_API_KEY` from your environment. You can also pass it explicitly:
+
+```python
+client = Computer(api_key="your-api-key")
 ```
 
-While you can provide an `api_key` keyword argument,
-we recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)
-to add `TZAFON_API_KEY="My API Key"` to your `.env` file
-so that your API Key is not stored in source control.
+We recommend using [python-dotenv](https://pypi.org/project/python-dotenv/) to manage your API key in a `.env` file.
 
-## Async usage
+## Async Usage
 
-Simply import `AsyncComputer` instead of `Computer` and use `await` with each API call:
+Import `AsyncComputer` and use `await` with each action:
 
 ```python
-import os
 import asyncio
 from tzafon import AsyncComputer
 
-client = AsyncComputer(
-    api_key=os.environ.get("TZAFON_API_KEY"),  # This is the default and can be omitted
-)
-
-
-async def main() -> None:
-    computer_response = await client.computers.create(
-        kind="browser",
-    )
-    print(computer_response.id)
-
+async def main():
+    client = AsyncComputer()
+    
+    async with client.create(kind="browser") as computer:
+        await computer.navigate("https://google.com")
+        await computer.type("Tzafon AI")
+        await computer.click(100, 200)
+        screenshot = await computer.screenshot()
 
 asyncio.run(main())
 ```
 
-Functionality between the synchronous and asynchronous clients is otherwise identical.
-
 ### With aiohttp
 
 By default, the async client uses `httpx` for HTTP requests. However, for improved concurrency performance you may also use `aiohttp` as the HTTP backend.

{tzafon-2.0.0 → tzafon-2.1.0}/README.md

@@ -1,17 +1,19 @@
-# Computer Python API library
+# Tzafon Python SDK
 
 <!-- prettier-ignore -->
 [![PyPI version](https://img.shields.io/pypi/v/tzafon.svg?label=pypi%20(stable))](https://pypi.org/project/tzafon/)
 
-The Computer Python library provides convenient access to the Computer REST API from any Python 3.8+
-application. The library includes type definitions for all request params and response fields,
-and offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).
+The Tzafon Python SDK provides programmatic control of Chromium browsers and Linux desktop environments. Automate web interactions with simple method calls - navigate, click, type, and capture screenshots.
 
-It is generated with [Stainless](https://www.stainless.com/).
+**Key Features:**
+- Browser and desktop automation
+- Synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx)
+- Type-safe API with full type definitions
+- Context manager support for automatic cleanup
 
 ## Documentation
 
-The REST API documentation can be found on [docs.tzafon.ai](http://docs.tzafon.ai). The full API of this library can be found in [api.md](api.md).
+The REST API documentation can be found at [docs.tzafon.ai](https://docs.tzafon.ai). The full API of this library can be found in [api.md](api.md).
 
 ## Installation
 
@@ -22,53 +24,47 @@ pip install tzafon
 
 ## Usage
 
-The full API of this library can be found in [api.md](api.md).
-
 ```python
-import os
 from tzafon import Computer
 
-client = Computer(
-    api_key=os.environ.get("TZAFON_API_KEY"),  # This is the default and can be omitted
-)
+client = Computer()  # Reads TZAFON_API_KEY from environment
 
-computer_response = client.computers.create(
-    kind="browser",
-)
-print(computer_response.id)
+# Create and control a browser instance
+with client.create(kind="browser") as computer:
+    computer.navigate("https://google.com")
+    computer.type("Tzafon AI")
+    computer.click(100, 200)
+    screenshot = computer.screenshot()
+```
+
+The client automatically reads `TZAFON_API_KEY` from your environment. You can also pass it explicitly:
+
+```python
+client = Computer(api_key="your-api-key")
 ```
 
-While you can provide an `api_key` keyword argument,
-we recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)
-to add `TZAFON_API_KEY="My API Key"` to your `.env` file
-so that your API Key is not stored in source control.
+We recommend using [python-dotenv](https://pypi.org/project/python-dotenv/) to manage your API key in a `.env` file.
 
-## Async usage
+## Async Usage
 
-Simply import `AsyncComputer` instead of `Computer` and use `await` with each API call:
+Import `AsyncComputer` and use `await` with each action:
 
 ```python
-import os
 import asyncio
 from tzafon import AsyncComputer
 
-client = AsyncComputer(
-    api_key=os.environ.get("TZAFON_API_KEY"),  # This is the default and can be omitted
-)
-
-
-async def main() -> None:
-    computer_response = await client.computers.create(
-        kind="browser",
-    )
-    print(computer_response.id)
-
+async def main():
+    client = AsyncComputer()
+    
+    async with client.create(kind="browser") as computer:
+        await computer.navigate("https://google.com")
+        await computer.type("Tzafon AI")
+        await computer.click(100, 200)
+        screenshot = await computer.screenshot()
 
 asyncio.run(main())
 ```
 
-Functionality between the synchronous and asynchronous clients is otherwise identical.
-
 ### With aiohttp
 
 By default, the async client uses `httpx` for HTTP requests. However, for improved concurrency performance you may also use `aiohttp` as the HTTP backend.

{tzafon-2.0.0 → tzafon-2.1.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "tzafon"
-version = "2.0.0"
+version = "2.1.0"
 description = "The official Python library for the computer API"
 dynamic = ["readme"]
 license = "MIT"

{tzafon-2.0.0 → tzafon-2.1.0}/src/tzafon/_streaming.py

@@ -57,9 +57,8 @@ class Stream(Generic[_T]):
         for sse in iterator:
             yield process_data(data=sse.json(), cast_to=cast_to, response=response)
 
-        # Ensure the entire stream is consumed
-        for _sse in iterator:
-            ...
+        # As we might not fully consume the response stream, we need to close it explicitly
+        response.close()
 
     def __enter__(self) -> Self:
         return self
@@ -121,9 +120,8 @@ class AsyncStream(Generic[_T]):
         async for sse in iterator:
             yield process_data(data=sse.json(), cast_to=cast_to, response=response)
 
-        # Ensure the entire stream is consumed
-        async for _sse in iterator:
-            ...
+        # As we might not fully consume the response stream, we need to close it explicitly
+        await response.aclose()
 
     async def __aenter__(self) -> Self:
         return self

{tzafon-2.0.0 → tzafon-2.1.0}/src/tzafon/_version.py

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

{tzafon-2.0.0 → tzafon-2.1.0}/src/tzafon/resources/computers.py

@@ -66,7 +66,9 @@ class ComputersResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> ComputerResponse:
         """
-        Create a new browser or desktop automation session
+        Create a new browser or desktop automation session with configurable timeout.
+        Returns endpoints for executing actions, streaming events, and viewing
+        screencast.
 
         Args:
           display: TODO: implement
@@ -113,7 +115,7 @@ class ComputersResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> ComputerResponse:
         """
-        Get the current status of a computer instance
+        Get the current status and metadata of a computer instance
 
         Args:
           extra_headers: Send extra headers
@@ -166,7 +168,8 @@ class ComputersResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> ActionResult:
         """
-        Execute a single action (screenshot, click, type, navigate, )
+        Execute a single action such as screenshot, click, type, navigate, scroll, debug
+        or other computer use actions
 
         Args:
           extra_headers: Send extra headers
@@ -235,7 +238,7 @@ class ComputersResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> ComputerKeepAliveResponse:
         """
-        Extend the timeout for a computer session
+        Extend the timeout for a computer session and verify it is still running
 
         Args:
           extra_headers: Send extra headers
@@ -337,7 +340,8 @@ class ComputersResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> None:
         """
-        Terminate and clean up a computer instance
+        Terminate and clean up a computer instance, stopping the session and recording
+        metrics
 
         Args:
           extra_headers: Send extra headers
@@ -396,7 +400,9 @@ class AsyncComputersResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> ComputerResponse:
         """
-        Create a new browser or desktop automation session
+        Create a new browser or desktop automation session with configurable timeout.
+        Returns endpoints for executing actions, streaming events, and viewing
+        screencast.
 
         Args:
           display: TODO: implement
@@ -443,7 +449,7 @@ class AsyncComputersResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> ComputerResponse:
         """
-        Get the current status of a computer instance
+        Get the current status and metadata of a computer instance
 
         Args:
           extra_headers: Send extra headers
@@ -496,7 +502,8 @@ class AsyncComputersResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> ActionResult:
         """
-        Execute a single action (screenshot, click, type, navigate, )
+        Execute a single action such as screenshot, click, type, navigate, scroll, debug
+        or other computer use actions
 
         Args:
           extra_headers: Send extra headers
@@ -565,7 +572,7 @@ class AsyncComputersResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> ComputerKeepAliveResponse:
         """
-        Extend the timeout for a computer session
+        Extend the timeout for a computer session and verify it is still running
 
         Args:
           extra_headers: Send extra headers
@@ -667,7 +674,8 @@ class AsyncComputersResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> None:
         """
-        Terminate and clean up a computer instance
+        Terminate and clean up a computer instance, stopping the session and recording
+        metrics
 
         Args:
           extra_headers: Send extra headers

{tzafon-2.0.0 → tzafon-2.1.0}/src/tzafon/types/action_result.py

@@ -10,6 +10,8 @@ __all__ = ["ActionResult"]
 class ActionResult(BaseModel):
     error_message: Optional[str] = None
 
+    request_id: Optional[str] = None
+
     result: Optional[Dict[str, object]] = None
 
     status: Optional[str] = None

tzafon-2.0.0/.release-please-manifest.json

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