tinyfish 0.2.3__tar.gz → 0.2.4__tar.gz

tinyfish-0.2.4/.pre-commit-config.yaml

@@ -0,0 +1,23 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+      - id: check-toml
+      - id: debug-statements
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.5
+    hooks:
+      - id: ruff-check
+      - id: ruff-format
+
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    rev: 0.10.9
+    hooks:
+      - id: uv-lock
+        name: uv-lock
+        files: ^sdk/sdk-python/(uv\.lock|pyproject\.toml)$

tinyfish-0.2.4/CLAUDE.md

@@ -0,0 +1,60 @@
+# TinyFish Python SDK (`tinyfish`)
+
+Official Python SDK for TinyFish. Provides sync (`TinyFish`) and async (`AsyncTinyFish`) clients for running
+automations, streaming events, and managing runs.
+
+For full method reference and examples: see `README.md`.
+
+---
+
+## Package Manager
+
+`uv` — not pip, not poetry.
+
+## Key Entry Points
+
+```
+src/tinyfish/__init__.py    → exports TinyFish, AsyncTinyFish, and all public types
+src/tinyfish/client.py      → TinyFish client class (sync)
+src/tinyfish/agent/         → agent.run(), agent.queue(), agent.stream()
+src/tinyfish/runs/          → runs.get(), runs.list()
+src/tinyfish/_utils/        → HTTP client base (sync + async), retry, error handling
+```
+
+## Quick Usage
+
+```python
+from tinyfish import TinyFish
+
+client = TinyFish(api_key="your-api-key")  # or set TINYFISH_API_KEY env var
+response = client.agent.run(goal="...", url="https://...")
+print(response.result)
+```
+
+## Tests
+
+```bash
+cd sdk/sdk-python && uv run pytest
+```
+
+## Pre-commit Hooks
+
+```bash
+cd sdk/sdk-python && pre-commit install
+```
+
+Hooks: `ruff format`, `ruff check`, `uv-lock` sync. Run before first commit and after any dep change.
+
+## Lint / Format
+
+```bash
+cd sdk/sdk-python && uv run ruff check . && uv run ruff format .
+```
+
+## Package name
+
+`tinyfish` (PyPI). The npm org uses a hyphen: `@tiny-fish/` (not `@tinyfish/`).
+
+## Further Reading
+
+See `README.md` for full usage examples, authentication patterns, and SDK changelog.

{tinyfish-0.2.3 → tinyfish-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tinyfish
-Version: 0.2.3
+Version: 0.2.4
 Summary: Official Python SDK for the TinyFish API
 Requires-Python: >=3.11
 Requires-Dist: httpx>=0.27.0

tinyfish-0.2.4/docs/internal/api-integration-header.md

@@ -0,0 +1,58 @@
+# API Integration Tagging (`TF_API_INTEGRATION`)
+
+Internal-only mechanism for identifying which integration platform is making API requests through our SDK.
+
+## How it works
+
+The SDK reads the `TF_API_INTEGRATION` environment variable when building request bodies. When set, the SDK injects `api_integration` into every request body sent to the automation endpoints.
+
+```text
+TF_API_INTEGRATION=n8n  -->  { "goal": "...", "url": "...", "api_integration": "n8n" }
+```
+
+This reuses the existing `api_integration` body field that the server already parses, stores in the DB, and emits to PostHog — no backend changes needed.
+
+This is intentionally **not** exposed as a constructor parameter or public API. It does not appear in editor autocomplete, type definitions, or documentation. Only we control which integrations set this value.
+
+## Environment variable
+
+| Variable              | Example values         | Required |
+| --------------------- | ---------------------- | -------- |
+| `TF_API_INTEGRATION`  | `n8n`, `dify`, `zapier` | No       |
+
+When unset or empty, `api_integration` is omitted from the body. Existing behavior is unchanged.
+
+## Where it's read
+
+`src/tinyfish/_utils/client/_base.py` — `_inject_integration()`, called from `_request()` in both sync and async clients:
+
+```python
+integration = os.environ.get("TF_API_INTEGRATION", "").strip()
+if integration:
+    json["api_integration"] = integration
+```
+
+This runs on every API request automatically — no per-resource setup needed.
+
+## Server-side flow
+
+1. Server validates `api_integration` via Zod schema (`frontend/app/v1/schemas.ts`)
+2. `buildRunOptions()` extracts it from the request body
+3. Stored in `runs.api_integration` DB column
+4. Emitted on `run_completed` PostHog event as `api_integration` property
+
+## Setting up a new integration
+
+To tag requests from a new integration partner:
+
+1. Set `TF_API_INTEGRATION=<name>` in the environment where the SDK runs (e.g., the n8n node, Dify plugin, Zapier action)
+2. No SDK code changes needed — the env var is picked up automatically
+3. The value will appear in PostHog under `run_completed.api_integration`
+
+## Tests
+
+`tests/test_client.py`:
+
+- `test_integration_in_body_via_env` — `api_integration` is in the request body when env var is set
+- `test_no_integration_in_body_by_default` — `api_integration` is absent when env var is not set
+- `test_async_integration_in_body_via_env` — async client variant

{tinyfish-0.2.3 → tinyfish-0.2.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "tinyfish"
-version = "0.2.3"
+version = "0.2.4"
 description = "Official Python SDK for the TinyFish API"
 readme = "README.md"
 requires-python = ">=3.11"
@@ -33,6 +33,10 @@ asyncio_default_fixture_loop_scope = "session"
 [tool.ruff]
 src = ["src"]
 line-length = 120
+[tool.ruff.format]
+quote-style = "double"
+docstring-code-format = true
+docstring-code-line-length = 20
 
 [tool.ruff.lint]
 select = ["E", "F", "I", "UP", "PYI", "TID"]

{tinyfish-0.2.3 → tinyfish-0.2.4}/src/tinyfish/_utils/client/_base.py

@@ -4,7 +4,7 @@ from __future__ import annotations
 
 import os
 from importlib.metadata import version as _pkg_version
-from typing import TypeVar
+from typing import Any, TypeVar
 
 import httpx
 from pydantic import BaseModel
@@ -79,8 +79,19 @@ class _BaseClient:
             "Accept": "application/json",
             "X-API-Key": self._api_key,
             "User-Agent": f"tinyfish-python/{_pkg_version('tinyfish')}",
+            "X-TF-Request-Origin": "tinyfish-python",
         }
 
+    @staticmethod
+    def _inject_integration(json: dict[str, Any] | None) -> dict[str, Any] | None:
+        """Inject api_integration from TF_API_INTEGRATION env var into JSON body."""
+        if json is None:
+            return None
+        integration = os.environ.get("TF_API_INTEGRATION", "").strip()
+        if integration:
+            json["api_integration"] = integration
+        return json
+
     def _make_status_error(self, response: httpx.Response) -> APIStatusError:
         """
         Translate an error HTTP response into the appropriate SDK exception.

{tinyfish-0.2.3 → tinyfish-0.2.4}/src/tinyfish/_utils/client/async_.py

@@ -72,6 +72,7 @@ class BaseAsyncAPIClient(_BaseClient):
             APIConnectionError: Network/connection error
             APIStatusError: HTTP error status (4xx, 5xx)
         """
+        json = self._inject_integration(json)
         max_attempts = self._max_retries + 1
 
         # Retryable: 408, 429, 5xx, and network errors (TimeoutException ⊂ RequestError).
@@ -142,6 +143,7 @@ class BaseAsyncAPIClient(_BaseClient):
         matching the retry behaviour of ``_request()``. Once a 200 response
         is received and streaming begins, no further retries are attempted.
         """
+        json = self._inject_integration(json)
         max_attempts = self._max_retries + 1
 
         @retry(

{tinyfish-0.2.3 → tinyfish-0.2.4}/src/tinyfish/_utils/client/sync.py

@@ -72,6 +72,7 @@ class BaseSyncAPIClient(_BaseClient):
             APIConnectionError: Network/connection error
             APIStatusError: HTTP error status (4xx, 5xx)
         """
+        json = self._inject_integration(json)
         max_attempts = self._max_retries + 1
 
         # Retryable: 408, 429, 5xx, and network errors (TimeoutException ⊂ RequestError).
@@ -142,6 +143,7 @@ class BaseSyncAPIClient(_BaseClient):
         matching the retry behaviour of ``_request()``. Once a 200 response
         is received and streaming begins, no further retries are attempted.
         """
+        json = self._inject_integration(json)
         max_attempts = self._max_retries + 1
 
         @retry(

{tinyfish-0.2.3 → tinyfish-0.2.4}/src/tinyfish/agent/__init__.py

@@ -41,8 +41,15 @@ class AgentStream:
 
     Use as::
 
-        with client.agent.stream(goal=..., url=...) as stream:
-            for event in stream:
+        with (
+            client.agent.stream(
+                goal=...,
+                url=...,
+            ) as stream
+        ):
+            for (
+                event
+            ) in stream:
                 ...
     """
 
@@ -64,8 +71,15 @@ class AsyncAgentStream:
 
     Use as::
 
-        async with client.agent.stream(goal=..., url=...) as stream:
-            async for event in stream:
+        async with (
+            client.agent.stream(
+                goal=...,
+                url=...,
+            ) as stream
+        ):
+            async for (
+                event
+            ) in stream:
                 ...
     """
 
@@ -166,10 +180,22 @@ class AgentResource(BaseSyncAPIResource):
         Use the on_* callbacks for a reactive style, or iterate over
         the stream for a sequential style::
 
-            with client.agent.stream(goal=..., url=...) as stream:
-                for event in stream:
-                    if isinstance(event, ProgressEvent):
-                        print(event.purpose)
+            with (
+                client.agent.stream(
+                    goal=...,
+                    url=...,
+                ) as stream
+            ):
+                for (
+                    event
+                ) in stream:
+                    if isinstance(
+                        event,
+                        ProgressEvent,
+                    ):
+                        print(
+                            event.purpose
+                        )
 
         Args:
             goal: Natural language description of what to do on the page.
@@ -309,10 +335,22 @@ class AsyncAgentResource(BaseAsyncAPIResource):
         Use the on_* callbacks for a reactive style, or iterate over
         the stream for a sequential style::
 
-            async with client.agent.stream(goal=..., url=...) as stream:
-                async for event in stream:
-                    if isinstance(event, ProgressEvent):
-                        print(event.purpose)
+            async with (
+                client.agent.stream(
+                    goal=...,
+                    url=...,
+                ) as stream
+            ):
+                async for (
+                    event
+                ) in stream:
+                    if isinstance(
+                        event,
+                        ProgressEvent,
+                    ):
+                        print(
+                            event.purpose
+                        )
 
         Args:
             goal: Natural language description of what to do on the page.

{tinyfish-0.2.3 → tinyfish-0.2.4}/src/tinyfish/agent/types.py

@@ -67,12 +67,19 @@ class AgentRunResponse(BaseModel):
         ```python
         response = client.agent.run(
             goal="Find the price of iPhone 15",
-            url="https://www.apple.com"
+            url="https://www.apple.com",
         )
-        if response.status == "COMPLETED":
-            print(response.result)
+        if (
+            response.status
+            == "COMPLETED"
+        ):
+            print(
+                response.result
+            )
         else:
-            print(f"Failed: {response.error.message}")
+            print(
+                f"Failed: {response.error.message}"
+            )
         ```
     """
 
@@ -103,13 +110,19 @@ class AgentRunAsyncResponse(BaseModel):
         ```python
         response = client.agent.queue(
             goal="Extract product details",
-            url="https://example.com"
+            url="https://example.com",
+        )
+        print(
+            f"Run started: {response.run_id}"
         )
-        print(f"Run started: {response.run_id}")
 
         # Check status later
-        run = client.runs.get(response.run_id)
-        print(f"Status: {run.status}")
+        run = client.runs.get(
+            response.run_id
+        )
+        print(
+            f"Status: {run.status}"
+        )
         ```
     """
 

{tinyfish-0.2.3 → tinyfish-0.2.4}/tests/test_client.py

@@ -184,3 +184,46 @@ def test_repr_short_key():
     r = repr(c)
     assert "****" in r
     assert "short" not in r
+
+
+# ─── TF_API_INTEGRATION env var ───────────────────────────────────────────
+
+
+# TF_API_INTEGRATION env var injects api_integration into request body
+@pytest.mark.respx(base_url=BASE_URL)
+def test_integration_in_body_via_env(respx_mock: MockRouter):
+    with mock.patch.dict(os.environ, {"TF_API_INTEGRATION": "n8n"}):
+        c = TinyFish(api_key=API_KEY, base_url=BASE_URL, max_retries=0)
+        route = respx_mock.post(_PATH).mock(return_value=httpx.Response(200, json=_RUN_OK))
+        c.agent.run(**_BODY)
+    import json
+
+    body = json.loads(route.calls[0].request.content)
+    assert body["api_integration"] == "n8n"
+
+
+# Without TF_API_INTEGRATION, api_integration is not in request body
+@pytest.mark.respx(base_url=BASE_URL)
+def test_no_integration_in_body_by_default(respx_mock: MockRouter):
+    with mock.patch.dict(os.environ, {}, clear=False):
+        os.environ.pop("TF_API_INTEGRATION", None)
+        c = TinyFish(api_key=API_KEY, base_url=BASE_URL, max_retries=0)
+        route = respx_mock.post(_PATH).mock(return_value=httpx.Response(200, json=_RUN_OK))
+        c.agent.run(**_BODY)
+    import json
+
+    body = json.loads(route.calls[0].request.content)
+    assert "api_integration" not in body
+
+
+# Async client injects api_integration into request body when env var is set
+@pytest.mark.respx(base_url=BASE_URL)
+async def test_async_integration_in_body_via_env(respx_mock: MockRouter):
+    with mock.patch.dict(os.environ, {"TF_API_INTEGRATION": "dify"}):
+        route = respx_mock.post(_PATH).mock(return_value=httpx.Response(200, json=_RUN_OK))
+        async with AsyncTinyFish(api_key=API_KEY, base_url=BASE_URL, max_retries=0) as c:
+            await c.agent.run(**_BODY)
+    import json
+
+    body = json.loads(route.calls[0].request.content)
+    assert body["api_integration"] == "dify"

{tinyfish-0.2.3 → tinyfish-0.2.4}/uv.lock

@@ -322,7 +322,7 @@ wheels = [
 
 [[package]]
 name = "tinyfish"
-version = "0.2.3"
+version = "0.2.4"
 source = { editable = "." }
 dependencies = [
     { name = "httpx" },