tzafon 2.0.0__py3-none-any.whl → 2.1.0__py3-none-any.whl

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/_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/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/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.dist-info → tzafon-2.1.0.dist-info}/METADATA

@@ -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.dist-info → tzafon-2.1.0.dist-info}/RECORD

@@ -9,9 +9,9 @@ tzafon/_models.py,sha256=lKnskYPONAWDvWo8tmbbVk7HmG7UOsI0Nve0vSMmkRc,30452
 tzafon/_qs.py,sha256=craIKyvPktJ94cvf9zn8j8ekG9dWJzhWv0ob34lIOv4,4828
 tzafon/_resource.py,sha256=EseuwN0R4kKBVcQnyF4NgCeRtc6-OrR8yWVI5fOYGHM,1112
 tzafon/_response.py,sha256=Gaq-HHLZ76rKv515pCAMkfW4rbz_ManOH-7R640hrDE,28792
-tzafon/_streaming.py,sha256=SavIdu5Tnaelw60s19mwFijhkdhdxh1fDqZ1AoIwC0g,10108
+tzafon/_streaming.py,sha256=HIbrsW_WdZZmR-vQP1ZJUHFluu4t90Zx0xa7y055CBo,10157
 tzafon/_types.py,sha256=1kStHPi-XwmomGBE0xKVtz0mdRF4Svxb8NWZR4FaSiY,7236
-tzafon/_version.py,sha256=Xmm32ma4YAHkxQx4hLPJNHlAICiNdMqTyjv4I-XvgEI,158
+tzafon/_version.py,sha256=tys3ArnimnJ53ajKXZ3n_wgNFp5pTo6RH7-niTxiEn4,158
 tzafon/batch_wrapper.py,sha256=ESJGxScFZzdPwDTiCjCz6-QRsoB-_nxoZuHbN9HKbUE,3509
 tzafon/client_extensions.py,sha256=Tn3SkDYNl0B8M3U8eE39KNLsazKpbztAQSmBVVmzgCQ,1964
 tzafon/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -29,9 +29,9 @@ tzafon/_utils/_transform.py,sha256=NjCzmnfqYrsAikUHQig6N9QfuTVbKipuP3ur9mcNF-E,1
 tzafon/_utils/_typing.py,sha256=N_5PPuFNsaygbtA_npZd98SVN1LQQvFTKL6bkWPBZGU,4786
 tzafon/_utils/_utils.py,sha256=0dDqauUbVZEXV0NVl7Bwu904Wwo5eyFCZpQThhFNhyA,12253
 tzafon/resources/__init__.py,sha256=2tbxQpPYxwl6BYAmWlSblYFfmeBEasXs9oxh3vXRG2M,591
-tzafon/resources/computers.py,sha256=grGWVUW6JQuF02Yrup0hUY9_FLxcPXtZYdBL1yX68N8,31548
+tzafon/resources/computers.py,sha256=XmpC0lLK1nUYHXt66BtTmCZkHDqHHY-Zcr1Ng7Wo2v8,32106
 tzafon/types/__init__.py,sha256=kb0H5ErFRI_4U_KF2ElDt45ZTid6K1dyDjq5_VL_FKs,902
-tzafon/types/action_result.py,sha256=RE4iCBcGaUWXirCBNsjf00jLl_s173NN8-gCMtKVs0g,374
+tzafon/types/action_result.py,sha256=50zhorxTnftv-I4AO1598DmBZJPGFFYFXRolJNbjBqQ,412
 tzafon/types/computer_create_params.py,sha256=G9rhhm8ckcLbG5tM-vHrgG19-jmfUVN0KMcHodjNs4g,553
 tzafon/types/computer_execute_action_params.py,sha256=-s1B9iUBavL2R2MvQXDxixdYbzr-l24wqjPP9LDo-xQ,304
 tzafon/types/computer_execute_batch_params.py,sha256=hg5xchXjFmXv-I04hfygZYq5_TrkjmfhpmdWWsE3Axw,302
@@ -40,7 +40,7 @@ tzafon/types/computer_keep_alive_response.py,sha256=H75ugeXG2CetcGgwwKE_cYmr_ujD
 tzafon/types/computer_list_response.py,sha256=ABykSdzQgm_bNISk_F7GQaXWRB3WidA9tXuMjmNWZps,294
 tzafon/types/computer_navigate_params.py,sha256=mK4JWt0fqafLuoXHdOh_I6j-hJY0Ub0nAUkadA20v38,294
 tzafon/types/computer_response.py,sha256=agc6iysQzQR22edcoz84CuUpzQ7WLwsxEuo8ccwIbYc,404
-tzafon-2.0.0.dist-info/METADATA,sha256=2iW9BlxMc1cqphygM0H--uVmqNEOAhvLr8nsSrozjUU,13902
-tzafon-2.0.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-tzafon-2.0.0.dist-info/licenses/LICENSE,sha256=ciLXi9zfEehb4Tnhy-M9I2WSRUpZjx-FK1TEChVqlDo,1048
-tzafon-2.0.0.dist-info/RECORD,,
+tzafon-2.1.0.dist-info/METADATA,sha256=8CKg_mQZfKkm-cuStZatkurlM84RdSwb1GFCpDGMJRY,13873
+tzafon-2.1.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+tzafon-2.1.0.dist-info/licenses/LICENSE,sha256=ciLXi9zfEehb4Tnhy-M9I2WSRUpZjx-FK1TEChVqlDo,1048
+tzafon-2.1.0.dist-info/RECORD,,