tzafon 2.4.4__tar.gz

tzafon-2.4.4/.gitignore

@@ -0,0 +1,15 @@
+.prism.log
+_dev
+
+__pycache__
+.mypy_cache
+
+dist
+
+.venv
+.idea
+
+.env
+.envrc
+codegen.log
+Brewfile.lock.json

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

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

tzafon-2.4.4/CHANGELOG.md

@@ -0,0 +1,198 @@
+# Changelog
+
+## 2.4.4 (2025-11-04)
+
+Full Changelog: [v2.4.3...v2.4.4](https://github.com/tzafon/computer-python/compare/v2.4.3...v2.4.4)
+
+## 2.4.3 (2025-11-04)
+
+Full Changelog: [v2.4.2...v2.4.3](https://github.com/tzafon/computer-python/compare/v2.4.2...v2.4.3)
+
+### Bug Fixes
+
+* modifier list hotkeys ([f92f449](https://github.com/tzafon/computer-python/commit/f92f4493efa5111ffca00f28dc3a45d9bc285230))
+
+## 2.4.2 (2025-11-04)
+
+Full Changelog: [v2.4.1...v2.4.2](https://github.com/tzafon/computer-python/compare/v2.4.1...v2.4.2)
+
+## 2.4.1 (2025-11-04)
+
+Full Changelog: [v2.4.0...v2.4.1](https://github.com/tzafon/computer-python/compare/v2.4.0...v2.4.1)
+
+### Chores
+
+* **internal:** grammar fix (it's -> its) ([88dceea](https://github.com/tzafon/computer-python/commit/88dceead54766c6ebe6366c96b702b6c699d5d28))
+
+## 2.4.0 (2025-11-03)
+
+Full Changelog: [v2.3.3...v2.4.0](https://github.com/tzafon/computer-python/compare/v2.3.3...v2.4.0)
+
+### Features
+
+* add wait ([4a7a963](https://github.com/tzafon/computer-python/commit/4a7a9631ee0b4a1ca33c813faded83227f95471a))
+
+## 2.3.3 (2025-11-03)
+
+Full Changelog: [v2.3.2...v2.3.3](https://github.com/tzafon/computer-python/compare/v2.3.2...v2.3.3)
+
+## 2.3.2 (2025-11-03)
+
+Full Changelog: [v2.3.1...v2.3.2](https://github.com/tzafon/computer-python/compare/v2.3.1...v2.3.2)
+
+## 2.3.1 (2025-11-03)
+
+Full Changelog: [v2.3.0...v2.3.1](https://github.com/tzafon/computer-python/compare/v2.3.0...v2.3.1)
+
+## 2.3.0 (2025-11-03)
+
+Full Changelog: [v2.2.0...v2.3.0](https://github.com/tzafon/computer-python/compare/v2.2.0...v2.3.0)
+
+### Features
+
+* **api:** manual updates ([4247614](https://github.com/tzafon/computer-python/commit/4247614c9c5d391d84c80b7ad36dbc89002f1ec8))
+
+## 2.2.0 (2025-11-03)
+
+Full Changelog: [v2.1.0...v2.2.0](https://github.com/tzafon/computer-python/compare/v2.1.0...v2.2.0)
+
+### Features
+
+* **api:** api update ([4950128](https://github.com/tzafon/computer-python/commit/4950128991e4e714562709df3d84eb0f1270677b))
+
+
+### Chores
+
+* **internal/tests:** avoid race condition with implicit client cleanup ([b2a3169](https://github.com/tzafon/computer-python/commit/b2a3169289c6e5117cd42973594618e232e7eb1d))
+* remove custom code ([fa3ccd4](https://github.com/tzafon/computer-python/commit/fa3ccd4b257623a59e61db225e65e0ee415b3517))
+
+## 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)
+
+### Features
+
+* **api:** manual updates ([29bf74f](https://github.com/tzafon/computer-python/commit/29bf74fecae0fe2aaa70a9f6f5f7ca64ba5ddbff))
+
+## 1.4.0 (2025-10-20)
+
+Full Changelog: [v1.3.2...v1.4.0](https://github.com/atulgavandetzafon/computer-python/compare/v1.3.2...v1.4.0)
+
+### Features
+
+* **api:** manual updates ([6405afc](https://github.com/atulgavandetzafon/computer-python/commit/6405afc6031ccdc2e65dbd935d54c340c148a675))
+* renamed api key ([6800a00](https://github.com/atulgavandetzafon/computer-python/commit/6800a0019d321a9bc121745b1b3f9697b52ac565))
+
+
+### Chores
+
+* bump `httpx-aiohttp` version to 0.1.9 ([f5e4b7e](https://github.com/atulgavandetzafon/computer-python/commit/f5e4b7ed3a9a62190715a3e426e0c9cd430ad7d7))
+* **internal:** detect missing future annotations with ruff ([3c69485](https://github.com/atulgavandetzafon/computer-python/commit/3c69485eb903332d717f99730319c50f9a6a5776))
+
+## 1.3.2 (2025-10-08)
+
+Full Changelog: [v1.3.1...v1.3.2](https://github.com/atulgavandetzafon/computer-python/compare/v1.3.1...v1.3.2)
+
+### Chores
+
+* update SDK settings ([05f237e](https://github.com/atulgavandetzafon/computer-python/commit/05f237ee8b8b72f28301dda597201e051f1b7ef4))
+* update SDK settings ([89b4df6](https://github.com/atulgavandetzafon/computer-python/commit/89b4df64ee207a368dfa80e9ae47a9255da4d545))
+
+## 1.3.1 (2025-10-08)
+
+Full Changelog: [v1.3.0...v1.3.1](https://github.com/atulgavandetzafon/computer-python/compare/v1.3.0...v1.3.1)
+
+## 1.3.0 (2025-10-08)
+
+Full Changelog: [v1.2.0...v1.3.0](https://github.com/atulgavandetzafon/computer-python/compare/v1.2.0...v1.3.0)
+
+### Features
+
+* **api:** manual updates ([92a3ec3](https://github.com/atulgavandetzafon/computer-python/commit/92a3ec3c358004e432973fedd6844add8bcb1c7d))
+
+## 1.2.0 (2025-10-08)
+
+Full Changelog: [v1.1.4...v1.2.0](https://github.com/atulgavandetzafon/computer-python/compare/v1.1.4...v1.2.0)
+
+### Features
+
+* **api:** manual updates ([8ce5b6b](https://github.com/atulgavandetzafon/computer-python/commit/8ce5b6bc92fffc1baf956972489ceefbf987be3b))
+* **api:** manual updates ([8fa5045](https://github.com/atulgavandetzafon/computer-python/commit/8fa5045b6bfbf00a3d44833100d36b58d27a83e3))
+* **api:** manual updates ([3dc796f](https://github.com/atulgavandetzafon/computer-python/commit/3dc796fb27186307f81f6e3ad93e6715a707604d))
+* **api:** manual updates ([ff7ae66](https://github.com/atulgavandetzafon/computer-python/commit/ff7ae66be8c4d9c69b52f803b23a0456aebe3c1e))
+* **api:** manual updates ([3492063](https://github.com/atulgavandetzafon/computer-python/commit/3492063eeb600e5c42585ebc8805b50cc0ffe9c0))
+* **api:** manual updates ([a68cfdb](https://github.com/atulgavandetzafon/computer-python/commit/a68cfdb2689829e82063eb672e1736e9f66bd81e))
+* **api:** manual updates ([0e7ee2c](https://github.com/atulgavandetzafon/computer-python/commit/0e7ee2ca2568511b495a154a6b802dd5c4b42908))
+
+## 1.1.4 (2025-10-08)
+
+Full Changelog: [v1.1.3...v1.1.4](https://github.com/atulgavandetzafon/computer-python/compare/v1.1.3...v1.1.4)
+
+## 1.1.3 (2025-10-08)
+
+Full Changelog: [v1.1.2...v1.1.3](https://github.com/atulgavandetzafon/computer-python/compare/v1.1.2...v1.1.3)
+
+## 1.1.2 (2025-10-08)
+
+Full Changelog: [v1.1.1...v1.1.2](https://github.com/atulgavandetzafon/computer-python/compare/v1.1.1...v1.1.2)
+
+## 1.1.1 (2025-10-08)
+
+Full Changelog: [v1.1.0...v1.1.1](https://github.com/atulgavandetzafon/computer-python/compare/v1.1.0...v1.1.1)
+
+## 1.1.0 (2025-10-07)
+
+Full Changelog: [v1.0.1...v1.1.0](https://github.com/atulgavandetzafon/computer-python/compare/v1.0.1...v1.1.0)
+
+### Features
+
+* **api:** manual updates ([aaf8e53](https://github.com/atulgavandetzafon/computer-python/commit/aaf8e534415ea6bc8420f2ed8e3b854011a7bf71))
+* **api:** manual updates ([833115e](https://github.com/atulgavandetzafon/computer-python/commit/833115e5e6814f6347de3e0521faceb4bf9e15e8))
+
+
+### Chores
+
+* update SDK settings ([0b62c4b](https://github.com/atulgavandetzafon/computer-python/commit/0b62c4b04323dabf192fe31e11f45ea94f366411))
+
+## 1.0.1 (2025-10-07)
+
+Full Changelog: [v0.0.1...v1.0.1](https://github.com/atulgavandetzafon/computer-python/compare/v0.0.1...v1.0.1)
+
+### Features
+
+* **api:** added python ([7bc6a73](https://github.com/atulgavandetzafon/computer-python/commit/7bc6a73f549bb57bb176de454d395fd692159a0e))
+* **api:** manual updates ([57e4841](https://github.com/atulgavandetzafon/computer-python/commit/57e4841180a11f953e1d8db5e3c1ea7eebbb1d3e))
+* **api:** manual updates ([a23814e](https://github.com/atulgavandetzafon/computer-python/commit/a23814e85afaa64e2a429b2bcb6507b0accb46bc))
+* **api:** Updated to bearer auth ([c95903e](https://github.com/atulgavandetzafon/computer-python/commit/c95903e3795de2823b6266f914647dd55dc4eeba))
+* **api:** v2 api ([db7fdb5](https://github.com/atulgavandetzafon/computer-python/commit/db7fdb5cbcb3ed5f38c2fcebe824573172c223d1))
+* async ([38d796c](https://github.com/atulgavandetzafon/computer-python/commit/38d796c6538fad278abf122887a57a379c5a532b))
+* lets test functionality ([3d5f515](https://github.com/atulgavandetzafon/computer-python/commit/3d5f515098e71964a431849a37c88a7a017424d2))
+* wrapper test1 ([e329ec1](https://github.com/atulgavandetzafon/computer-python/commit/e329ec12ae711d64cad28e04a74bd7c1283669ce))
+
+
+### Bug Fixes
+
+* removed old async ([1b5c5cd](https://github.com/atulgavandetzafon/computer-python/commit/1b5c5cdf4a7c80089e8ca67e13540bdae898ac98))
+
+
+### Chores
+
+* update SDK settings ([a5da45a](https://github.com/atulgavandetzafon/computer-python/commit/a5da45a676c091d3d02fde9352d98d458e4dfe7f))
+* update SDK settings ([3e68f6d](https://github.com/atulgavandetzafon/computer-python/commit/3e68f6db27fae3f75f411d76e15a6df07d22fa2b))

tzafon-2.4.4/CONTRIBUTING.md

@@ -0,0 +1,128 @@
+## Setting up the environment
+
+### With Rye
+
+We use [Rye](https://rye.astral.sh/) to manage dependencies because it will automatically provision a Python environment with the expected Python version. To set it up, run:
+
+```sh
+$ ./scripts/bootstrap
+```
+
+Or [install Rye manually](https://rye.astral.sh/guide/installation/) and run:
+
+```sh
+$ rye sync --all-features
+```
+
+You can then run scripts using `rye run python script.py` or by activating the virtual environment:
+
+```sh
+# Activate the virtual environment - https://docs.python.org/3/library/venv.html#how-venvs-work
+$ source .venv/bin/activate
+
+# now you can omit the `rye run` prefix
+$ python script.py
+```
+
+### Without Rye
+
+Alternatively if you don't want to install `Rye`, you can stick with the standard `pip` setup by ensuring you have the Python version specified in `.python-version`, create a virtual environment however you desire and then install dependencies using this command:
+
+```sh
+$ pip install -r requirements-dev.lock
+```
+
+## Modifying/Adding code
+
+Most of the SDK is generated code. Modifications to code will be persisted between generations, but may
+result in merge conflicts between manual patches and changes from the generator. The generator will never
+modify the contents of the `src/tzafon/lib/` and `examples/` directories.
+
+## Adding and running examples
+
+All files in the `examples/` directory are not modified by the generator and can be freely edited or added to.
+
+```py
+# add an example to examples/<your-example>.py
+
+#!/usr/bin/env -S rye run python
+…
+```
+
+```sh
+$ chmod +x examples/<your-example>.py
+# run the example against your api
+$ ./examples/<your-example>.py
+```
+
+## Using the repository from source
+
+If you’d like to use the repository from source, you can either install from git or link to a cloned repository:
+
+To install via git:
+
+```sh
+$ pip install git+ssh://git@github.com/tzafon/computer-python.git
+```
+
+Alternatively, you can build from source and install the wheel file:
+
+Building this package will create two files in the `dist/` directory, a `.tar.gz` containing the source files and a `.whl` that can be used to install the package efficiently.
+
+To create a distributable version of the library, all you have to do is run this command:
+
+```sh
+$ rye build
+# or
+$ python -m build
+```
+
+Then to install:
+
+```sh
+$ pip install ./path-to-wheel-file.whl
+```
+
+## Running tests
+
+Most tests require you to [set up a mock server](https://github.com/stoplightio/prism) against the OpenAPI spec to run the tests.
+
+```sh
+# you will need npm installed
+$ npx prism mock path/to/your/openapi.yml
+```
+
+```sh
+$ ./scripts/test
+```
+
+## Linting and formatting
+
+This repository uses [ruff](https://github.com/astral-sh/ruff) and
+[black](https://github.com/psf/black) to format the code in the repository.
+
+To lint:
+
+```sh
+$ ./scripts/lint
+```
+
+To format and fix all ruff issues automatically:
+
+```sh
+$ ./scripts/format
+```
+
+## Publishing and releases
+
+Changes made to this repository via the automated release PR pipeline should publish to PyPI automatically. If
+the changes aren't made through the automated pipeline, you may want to make releases manually.
+
+### Publish with a GitHub workflow
+
+You can release to package managers by using [the `Publish PyPI` GitHub action](https://www.github.com/tzafon/computer-python/actions/workflows/publish-pypi.yml). This requires a setup organization or repository secret to be set up.
+
+### Publish manually
+
+If you need to manually release a package, you can run the `bin/publish-pypi` script with a `PYPI_TOKEN` set on
+the environment.

tzafon-2.4.4/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2025 computer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

tzafon-2.4.4/PKG-INFO

@@ -0,0 +1,229 @@
+Metadata-Version: 2.3
+Name: tzafon
+Version: 2.4.4
+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
+Author-email: Computer <atul.gavande@tzafon.ai>
+License: MIT
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: OS Independent
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.8
+Requires-Dist: anyio<5,>=3.5.0
+Requires-Dist: distro<2,>=1.7.0
+Requires-Dist: httpx<1,>=0.23.0
+Requires-Dist: pydantic<3,>=1.9.0
+Requires-Dist: sniffio
+Requires-Dist: typing-extensions<5,>=4.10
+Provides-Extra: aiohttp
+Requires-Dist: aiohttp; extra == 'aiohttp'
+Requires-Dist: httpx-aiohttp>=0.1.9; extra == 'aiohttp'
+Description-Content-Type: text/markdown
+
+# Tzafon Python SDK
+
+[![PyPI version](https://img.shields.io/pypi/v/tzafon.svg)](https://pypi.org/project/tzafon/)
+
+Remote browser and desktop automation. Control browsers and desktops programmatically through a simple Python API.
+
+## Installation
+
+```bash
+pip install tzafon
+```
+
+## Quick Start
+
+```python
+from tzafon import Computer
+
+client = Computer()  # Reads TZAFON_API_KEY from environment
+
+# Create and control a browser instance
+with client.create(kind="browser") as computer:
+    computer.navigate("https://wikipedia.com")
+
+    result = computer.screenshot()
+    url = computer.get_screenshot_url(result)
+    print(f"Screenshot: {url}")
+
+    computer.click(100, 200)
+    computer.type("Hello, world!")
+
+    # Automatically terminates when exiting context
+```
+
+Set your API key:
+```bash
+export TZAFON_API_KEY="your-api-key"
+```
+
+Or use a `.env` file with [python-dotenv](https://pypi.org/project/python-dotenv/).
+
+## Features
+
+**Session Management**
+- Context manager support for automatic cleanup
+- Manual session control when needed
+- Browser, desktop, and code environments
+
+**Browser Actions**
+- Navigation: `navigate(url)`
+- Mouse: `click()`, `double_click()`, `right_click()`, `drag()`
+- Keyboard: `type()`, `hotkey()`
+- Viewport: `scroll()`, `set_viewport()`
+- Capture: `screenshot()`, `html()`
+- Debug: Execute shell commands with `debug()`
+
+**Type Safety**
+- Full type annotations for IDE autocomplete
+- Pydantic models for responses
+- TypedDict for request parameters
+- Helper methods for result extraction
+
+## Examples
+
+### Browser Automation
+
+```python
+with client.create(kind="browser") as computer:
+    # Navigate and interact
+    computer.navigate("https://github.com/login")
+    computer.click(300, 400)
+    computer.type("username")
+    computer.hotkey("Control", "a")  # Select all
+
+    # Capture state
+    html_result = computer.html()
+    html = computer.get_html_content(html_result)
+
+    # Execute commands
+    debug_result = computer.debug("ls -la")
+    output = computer.get_debug_response(debug_result)
+```
+
+### Manual Session Management
+
+```python
+computer = client.create(kind="browser")
+try:
+    computer.navigate("https://example.com")
+    screenshot = computer.screenshot()
+finally:
+    computer.terminate()
+```
+
+### Async Support
+
+```python
+from tzafon import AsyncComputer
+
+async with AsyncComputer() as client:
+    computer = await client.computers.create(kind="browser")
+    await client.computers.navigate(computer.id, url="https://example.com")
+    await client.computers.terminate(computer.id)
+```
+
+## Advanced Usage
+
+### Raw SDK Access
+
+The simplified wrapper uses the generated SDK under the hood. You can access it directly:
+
+```python
+# Low-level API
+response = client.computers.create(kind="browser")
+client.computers.navigate(response.id, url="https://example.com")
+result = client.computers.capture_screenshot(response.id)
+client.computers.terminate(response.id)
+```
+
+### Error Handling
+
+```python
+import tzafon
+
+try:
+    with client.create(kind="browser") as computer:
+        computer.navigate("https://example.com")
+except tzafon.RateLimitError:
+    print("Rate limit exceeded, back off")
+except tzafon.AuthenticationError:
+    print("Invalid API key")
+except tzafon.APIError as e:
+    print(f"API error: {e}")
+```
+
+### Configuration
+
+```python
+from tzafon import Computer
+
+client = Computer(
+    api_key="your-api-key",       # Or use TZAFON_API_KEY env var
+    base_url="https://...",        # Optional: custom endpoint
+    timeout=120.0,                 # Request timeout in seconds
+    max_retries=2,                 # Retry failed requests
+)
+```
+
+## API Reference
+
+**Session Methods**
+- `navigate(url)` - Navigate to URL
+- `click(x, y)` - Click at coordinates
+- `double_click(x, y)` - Double-click
+- `right_click(x, y)` - Right-click
+- `drag(x1, y1, x2, y2)` - Click and drag
+- `type(text)` - Type text
+- `hotkey(*keys)` - Press key combination
+- `scroll(dx, dy)` - Scroll viewport
+- `screenshot(base64=False)` - Capture screenshot
+- `html(auto_detect_encoding=False)` - Get page HTML
+- `debug(command, timeout_seconds=120, max_output_length=65536)` - Run shell command
+- `set_viewport(width, height, scale_factor=1.0)` - Set viewport size
+- `terminate()` - End session
+
+**Helper Methods**
+- `get_screenshot_url(result)` - Extract screenshot URL from result
+- `get_html_content(result)` - Extract HTML from result
+- `get_debug_response(result)` - Extract command output from result
+
+## Error Codes
+
+| Status | Error Type |
+|--------|------------|
+| 400 | `BadRequestError` |
+| 401 | `AuthenticationError` |
+| 403 | `PermissionDeniedError` |
+| 404 | `NotFoundError` |
+| 422 | `UnprocessableEntityError` |
+| 429 | `RateLimitError` |
+| ≥500 | `InternalServerError` |
+
+## Documentation
+
+- REST API: [docs.tzafon.ai](https://docs.tzafon.ai)
+- Full API Reference: [api.md](https://github.com/tzafon/computer-python/tree/main/api.md)
+- Contributing: [CONTRIBUTING.md](https://github.com/tzafon/computer-python/tree/main/CONTRIBUTING.md)
+
+## Requirements
+
+Python 3.8+
+
+## License
+
+See [LICENSE](https://github.com/tzafon/computer-python/tree/main/LICENSE)