tidefold-client 0.0.226__tar.gz

tidefold_client-0.0.226/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

tidefold_client-0.0.226/PKG-INFO

@@ -0,0 +1,120 @@
+Metadata-Version: 2.4
+Name: tidefold-client
+Version: 0.0.226
+Summary: Python client for starting and following tidefold workflow runs
+Author: tidefold
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Operating System :: OS Independent
+Classifier: Typing :: Typed
+Requires-Dist: httpx>=0.27.0,<1.0.0
+Requires-Python: >=3.13, <4.0
+Description-Content-Type: text/markdown
+
+# tidefold-client
+
+A small Python client for starting workflow runs on a tidefold deployment,
+waiting for them, and reading what they produced.
+
+```sh
+pip install "tidefold-client==<your platform version>"
+```
+
+Install the version that matches your deployment's platform release. The
+client warns when it talks to a server on a different release. There is no
+compatibility promise across versions.
+
+## Quick start
+
+```python
+from tidefold_client import Client
+
+client = Client.from_env()  # TIDEFOLD_API_URL, TIDEFOLD_API_TOKEN
+
+run = client.workflows.start(
+    "invoice_review",
+    inputs={"reference": "INV-1042"},
+    files={"document": "invoice.pdf"},
+    subject="INV-1042",
+)
+run.wait(timeout=1800)
+print(run.results()["marked_results"])
+```
+
+`TIDEFOLD_API_URL` is the API root: `https://<your host>/api` on a
+deployment, `http://localhost:8000` on a local stack. There is no default.
+
+## The API token
+
+An administrator creates tokens under **Settings → API tokens**. A token is
+shown once; keep it in a secret store and pass it through the environment.
+Grant only the scopes your script needs:
+
+| Scope | Needed for |
+| --- | --- |
+| `workflow_read` | `workflows.list()`, `workflows.get_id()`, `workflows.start()` by name |
+| `run_create` | `workflows.start()` |
+| `run_file_write` | `files.upload()`, `workflows.start()` with `files` |
+| `run_read` | `runs.get()`, `runs.wait()`, `runs.results()`, `runs.usage()`, `files.download()` |
+| `run_cancel` | `runs.cancel()` |
+| `inbox_read` | `runs.requests()` |
+
+"Own data only" visibility suits scripts: the token then sees only the runs
+it started. A local stack running without auth takes no token.
+
+## The subclients
+
+The client has one subclient per resource, all sharing one session.
+
+**`client.workflows`**
+
+- `start(name, *, inputs, files, subject, correlation_id)` uploads each
+  file and starts a run on the workflow's latest published release
+  (`channel="draft"` runs the current draft). It returns a `Run` at once.
+  `workflow_id=` starts by id instead of name.
+- `list()` returns the workflows the token can see; `get_id(name)` resolves
+  a name to its stable id.
+
+**`client.runs`**, each taking a run id
+
+- `get()` reads the run as it stands.
+- `wait()` polls until the run ends. It returns the run on `COMPLETED` and
+  raises `RunFailed`, `RunCancelled` or `WaitTimeout`. A server restarting
+  during a deploy is waited out.
+- `results()` returns `results` per step and `marked_results`, the outputs
+  the workflow declares. `usage()`, `requests()` and `cancel()` do what
+  their names say.
+
+**`client.files`**
+
+- `upload(path)` declares the file, uploads it to the signed URL (never
+  with the token) and finalizes it; it returns the file's record.
+- `download(file_id, path)` saves a file, such as a produced document.
+
+A `Run` is `client.runs` with the id filled in: `run.wait()`,
+`run.results()` and so on. `client.run(run_id)` gives one for a run started
+earlier.
+
+**Starting is not idempotent.** The client never retries `start()`, and
+calling it twice starts two runs, even with the same `correlation_id`.
+
+## Errors
+
+Every exception derives from `TidefoldError`.
+
+| Exception | Meaning |
+| --- | --- |
+| `AuthError` | 401: token missing, wrong, expired or revoked |
+| `PermissionDenied` | 403: the token lacks the scope named in the message |
+| `NotFound` | 404: no such run or file; for a workflow, also a category the token cannot see |
+| `Conflict` | 409: workflow never published, or results read while the run is still running |
+| `InvalidRequest` | 400, 413, 422: a missing input, an oversized or unsupported file |
+| `UploadError` | a file did not upload; no run was started |
+| `RunFailed`, `RunCancelled`, `WaitTimeout` | raised by `wait()` |
+| `NetworkError` | the server could not be reached after retries |
+
+## License
+
+Apache-2.0.

tidefold_client-0.0.226/README.md

@@ -0,0 +1,105 @@
+# tidefold-client
+
+A small Python client for starting workflow runs on a tidefold deployment,
+waiting for them, and reading what they produced.
+
+```sh
+pip install "tidefold-client==<your platform version>"
+```
+
+Install the version that matches your deployment's platform release. The
+client warns when it talks to a server on a different release. There is no
+compatibility promise across versions.
+
+## Quick start
+
+```python
+from tidefold_client import Client
+
+client = Client.from_env()  # TIDEFOLD_API_URL, TIDEFOLD_API_TOKEN
+
+run = client.workflows.start(
+    "invoice_review",
+    inputs={"reference": "INV-1042"},
+    files={"document": "invoice.pdf"},
+    subject="INV-1042",
+)
+run.wait(timeout=1800)
+print(run.results()["marked_results"])
+```
+
+`TIDEFOLD_API_URL` is the API root: `https://<your host>/api` on a
+deployment, `http://localhost:8000` on a local stack. There is no default.
+
+## The API token
+
+An administrator creates tokens under **Settings → API tokens**. A token is
+shown once; keep it in a secret store and pass it through the environment.
+Grant only the scopes your script needs:
+
+| Scope | Needed for |
+| --- | --- |
+| `workflow_read` | `workflows.list()`, `workflows.get_id()`, `workflows.start()` by name |
+| `run_create` | `workflows.start()` |
+| `run_file_write` | `files.upload()`, `workflows.start()` with `files` |
+| `run_read` | `runs.get()`, `runs.wait()`, `runs.results()`, `runs.usage()`, `files.download()` |
+| `run_cancel` | `runs.cancel()` |
+| `inbox_read` | `runs.requests()` |
+
+"Own data only" visibility suits scripts: the token then sees only the runs
+it started. A local stack running without auth takes no token.
+
+## The subclients
+
+The client has one subclient per resource, all sharing one session.
+
+**`client.workflows`**
+
+- `start(name, *, inputs, files, subject, correlation_id)` uploads each
+  file and starts a run on the workflow's latest published release
+  (`channel="draft"` runs the current draft). It returns a `Run` at once.
+  `workflow_id=` starts by id instead of name.
+- `list()` returns the workflows the token can see; `get_id(name)` resolves
+  a name to its stable id.
+
+**`client.runs`**, each taking a run id
+
+- `get()` reads the run as it stands.
+- `wait()` polls until the run ends. It returns the run on `COMPLETED` and
+  raises `RunFailed`, `RunCancelled` or `WaitTimeout`. A server restarting
+  during a deploy is waited out.
+- `results()` returns `results` per step and `marked_results`, the outputs
+  the workflow declares. `usage()`, `requests()` and `cancel()` do what
+  their names say.
+
+**`client.files`**
+
+- `upload(path)` declares the file, uploads it to the signed URL (never
+  with the token) and finalizes it; it returns the file's record.
+- `download(file_id, path)` saves a file, such as a produced document.
+
+A `Run` is `client.runs` with the id filled in: `run.wait()`,
+`run.results()` and so on. `client.run(run_id)` gives one for a run started
+earlier.
+
+**Starting is not idempotent.** The client never retries `start()`, and
+calling it twice starts two runs, even with the same `correlation_id`.
+
+## Errors
+
+Every exception derives from `TidefoldError`.
+
+| Exception | Meaning |
+| --- | --- |
+| `AuthError` | 401: token missing, wrong, expired or revoked |
+| `PermissionDenied` | 403: the token lacks the scope named in the message |
+| `NotFound` | 404: no such run or file; for a workflow, also a category the token cannot see |
+| `Conflict` | 409: workflow never published, or results read while the run is still running |
+| `InvalidRequest` | 400, 413, 422: a missing input, an oversized or unsupported file |
+| `UploadError` | a file did not upload; no run was started |
+| `RunFailed`, `RunCancelled`, `WaitTimeout` | raised by `wait()` |
+| `NetworkError` | the server could not be reached after retries |
+
+## License
+
+Apache-2.0.

tidefold_client-0.0.226/pyproject.toml

@@ -0,0 +1,39 @@
+[project]
+name = "tidefold-client"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+# Every release tag stamps its own version into a copy of this file before
+# building (.github/workflows/publish-client.yml); 0.0.0+dev marks a
+# workspace install, which the client's server-version check ignores.
+version = "0.0.226"
+description = "Python client for starting and following tidefold workflow runs"
+authors = [
+    {name = "tidefold"}
+]
+readme = "README.md"
+requires-python = ">=3.13, <4.0"
+# Standalone by contract: published to public PyPI, so it imports nothing
+# from the platform libraries or the api.
+dependencies = [
+    "httpx (>=0.27.0,<1.0.0)",
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.13",
+    "Operating System :: OS Independent",
+    "Typing :: Typed",
+]
+
+[tool.uv]
+package = true
+
+[build-system]
+# Pinned below the next minor, as uv_build's versions track uv's.
+requires = ["uv_build>=0.10.9,<0.11"]
+build-backend = "uv_build"
+
+# Flat layout. The sdist holds the module, pyproject.toml, README.md and
+# LICENSE; the tests are outside the module and never ship.
+[tool.uv.build-backend]
+module-name = "tidefold_client"
+module-root = ""

tidefold_client-0.0.226/tidefold_client/__init__.py

@@ -0,0 +1,48 @@
+"""Start and follow tidefold workflow runs over the REST API."""
+
+from tidefold_client._client import Client
+from tidefold_client._errors import (
+    ApiError,
+    AuthError,
+    Conflict,
+    InvalidRequest,
+    NetworkError,
+    NotFound,
+    PermissionDenied,
+    RunCancelled,
+    RunError,
+    RunFailed,
+    TidefoldError,
+    UploadError,
+    WaitTimeout,
+)
+from tidefold_client._files import FilePath, Files
+from tidefold_client._runs import Run, Runs
+from tidefold_client._transport import CLIENT_VERSION
+from tidefold_client._workflows import FileInputs, Workflows
+
+__version__ = CLIENT_VERSION
+
+__all__ = [
+    "ApiError",
+    "AuthError",
+    "Client",
+    "Conflict",
+    "FileInputs",
+    "FilePath",
+    "Files",
+    "InvalidRequest",
+    "NetworkError",
+    "NotFound",
+    "PermissionDenied",
+    "Run",
+    "RunCancelled",
+    "RunError",
+    "RunFailed",
+    "Runs",
+    "TidefoldError",
+    "UploadError",
+    "WaitTimeout",
+    "Workflows",
+    "__version__",
+]

tidefold_client-0.0.226/tidefold_client/_client.py

@@ -0,0 +1,76 @@
+"""The client: one API root, one subclient per resource."""
+
+import os
+from types import TracebackType
+from typing import Any, Self
+
+import httpx
+
+from tidefold_client._files import Files
+from tidefold_client._runs import Run, Runs
+from tidefold_client._transport import DEFAULT_TIMEOUT_SECONDS, Transport
+from tidefold_client._workflows import Workflows
+
+
+class Client:
+    """A client for one tidefold API.
+
+    ``base_url`` is the API root as the API is mounted:
+    ``https://<host>/api`` on a deployment, ``http://localhost:8000`` on a
+    local stack. ``token`` is an API token (``sk_...``); a local stack
+    running without auth takes none. ``http`` replaces the client's own
+    ``httpx.Client``, for proxies, custom transports or tests.
+
+    Each resource is a subclient sharing one session: ``workflows``,
+    ``runs`` and ``files``.
+    """
+
+    def __init__(
+        self,
+        base_url: str,
+        token: str | None = None,
+        *,
+        http: httpx.Client | None = None,
+        timeout: float = DEFAULT_TIMEOUT_SECONDS,
+    ) -> None:
+        self._transport = Transport(base_url, token, http=http, timeout=timeout)
+        self.files = Files(self._transport)
+        self.runs = Runs(self._transport)
+        self.workflows = Workflows(self._transport, files=self.files, runs=self.runs)
+
+    @classmethod
+    def from_env(cls, *, http: httpx.Client | None = None) -> Self:
+        """A client configured by ``TIDEFOLD_API_URL`` and ``TIDEFOLD_API_TOKEN``."""
+        base_url = os.environ.get("TIDEFOLD_API_URL", "")
+        if not base_url:
+            msg = "TIDEFOLD_API_URL is not set"
+            raise ValueError(msg)
+        token = os.environ.get("TIDEFOLD_API_TOKEN") or None
+        return cls(base_url, token, http=http)
+
+    def __enter__(self) -> Self:
+        return self
+
+    def __exit__(
+        self,
+        exc_type: type[BaseException] | None,
+        exc: BaseException | None,
+        traceback: TracebackType | None,
+    ) -> None:
+        self.close()
+
+    def __repr__(self) -> str:
+        token = "set" if self._transport.has_token else "none"
+        return f"Client(base_url={self._transport.base!r}, token={token})"
+
+    def close(self) -> None:
+        """Close the underlying HTTP client, unless the caller supplied it."""
+        self._transport.close()
+
+    def server_version(self) -> dict[str, Any]:
+        """The server's build: ``{"git_sha": ..., "image_tag": ...}``."""
+        return self._transport.server_version()
+
+    def run(self, run_id: str) -> Run:
+        """A handle on a run started earlier: ``client.runs`` with its id."""
+        return Run(self.runs, run_id)

tidefold_client-0.0.226/tidefold_client/_errors.py

@@ -0,0 +1,86 @@
+"""The exceptions the client raises, all under :class:`TidefoldError`."""
+
+from typing import Any
+
+
+class TidefoldError(Exception):
+    """Base class of every error the client raises."""
+
+
+class NetworkError(TidefoldError):
+    """The server could not be reached, after the client's own retries."""
+
+
+class ApiError(TidefoldError):
+    """The API answered with an error status.
+
+    ``path`` is the request's path without its query string, so a signed
+    URL's signature never ends up in a message or a log line.
+    """
+
+    def __init__(
+        self, message: str, *, status: int, method: str, path: str, detail: str
+    ) -> None:
+        super().__init__(message)
+        self.status = status
+        self.method = method
+        self.path = path
+        self.detail = detail
+
+
+class AuthError(ApiError):
+    """401: the token is missing, wrong, expired or revoked."""
+
+
+class PermissionDenied(ApiError):
+    """403: the token lacks the scope this call needs."""
+
+
+class NotFound(ApiError):
+    """404: the run, file or workflow does not exist for this token."""
+
+
+class Conflict(ApiError):
+    """409: the request clashes with the resource's current state."""
+
+
+class InvalidRequest(ApiError):
+    """400, 413 or 422: the API rejected the request as sent."""
+
+
+class UploadError(TidefoldError):
+    """An input file did not upload; no run was started."""
+
+    def __init__(self, message: str, *, file: str, status: str | int | None) -> None:
+        super().__init__(message)
+        self.file = file
+        self.status = status
+
+
+class RunError(TidefoldError):
+    """A run ended without completing. ``run`` is its last read."""
+
+    def __init__(self, message: str, *, run: dict[str, Any]) -> None:
+        super().__init__(message)
+        self.run = run
+        self.run_id: str = run.get("id", "")
+
+
+class RunFailed(RunError):
+    """The run ended ``FAILED``."""
+
+
+class RunCancelled(RunError):
+    """The run ended ``CANCELLED``."""
+
+
+class WaitTimeout(TidefoldError):
+    """``Run.wait`` gave up; the run itself keeps going on the server."""
+
+    def __init__(
+        self, message: str, *, run_id: str, timeout: float, last_status: str | None
+    ) -> None:
+        super().__init__(message)
+        self.run_id = run_id
+        self.timeout = timeout
+        self.last_status = last_status

tidefold_client-0.0.226/tidefold_client/_files.py

@@ -0,0 +1,76 @@
+"""``client.files``: upload run inputs, download what runs produced."""
+
+import hashlib
+import logging
+import mimetypes
+import os
+from pathlib import Path
+from typing import Any
+
+from tidefold_client._errors import ApiError, UploadError
+from tidefold_client._transport import Transport
+
+logger = logging.getLogger("tidefold_client")
+
+type FilePath = str | os.PathLike[str]
+
+
+class Files:
+    """The ``/v1/files`` routes."""
+
+    def __init__(self, transport: Transport) -> None:
+        self._transport = transport
+
+    def upload(self, path: FilePath) -> dict[str, Any]:
+        """Upload one file as run data; return its record once ``READY``.
+
+        Declares the file (size and sha256), sends the bytes to the signed
+        URL the API grants (never with the token), and finalizes. The
+        record's ``id`` is what a run's file input takes.
+        """
+        source = Path(path)
+        content = source.read_bytes()
+        mime_type = mimetypes.guess_type(source.name)[0] or "application/octet-stream"
+        grant = self._transport.json(
+            "POST",
+            "v1/files/uploads",
+            scope="run_file_write",
+            json_body={
+                "name": source.name,
+                "mime_type": mime_type,
+                "size": len(content),
+                "sha256": hashlib.sha256(content).hexdigest(),
+            },
+        )
+        try:
+            self._transport.request(
+                grant.get("method", "PUT"),
+                grant["url"],
+                auth=False,
+                content=content,
+                headers=grant.get("headers") or {},
+            )
+        except ApiError as exc:
+            msg = f"upload of {source.name} was rejected: {exc}"
+            raise UploadError(msg, file=source.name, status=exc.status) from exc
+        record = self._transport.json(
+            "POST", f"v1/files/{grant['file_id']}/finalize", retry=True
+        )
+        status = record.get("upload_status")
+        if status != "READY":
+            msg = f"upload of {source.name} is {status}, not READY"
+            raise UploadError(msg, file=source.name, status=status)
+        logger.debug("uploaded %s as %s", source.name, grant["file_id"])
+        return record
+
+    def download(self, file_id: str, dest: FilePath) -> Path:
+        """Write a file's content to ``dest`` and return its path."""
+        target = Path(dest)
+        path = f"v1/files/{file_id}/content"
+        with (
+            self._transport.stream(path, scope="run_read") as response,
+            target.open("wb") as out,
+        ):
+            for chunk in response.iter_bytes():
+                out.write(chunk)
+        return target

tidefold_client-0.0.226/tidefold_client/_runs.py

@@ -0,0 +1,187 @@
+"""``client.runs``: read, wait for and cancel workflow runs."""
+
+import logging
+import time
+from typing import Any
+
+import httpx
+
+from tidefold_client._errors import (
+    ApiError,
+    NetworkError,
+    RunCancelled,
+    RunFailed,
+    WaitTimeout,
+)
+from tidefold_client._transport import Transport
+
+logger = logging.getLogger("tidefold_client")
+
+_TRANSIENT = frozenset(
+    {
+        httpx.codes.BAD_GATEWAY,
+        httpx.codes.SERVICE_UNAVAILABLE,
+        httpx.codes.GATEWAY_TIMEOUT,
+    }
+)
+_RUNNING = frozenset({"RUNNING", "CANCELLING"})
+_FAILED_STEP = frozenset({"FAILED", "BLOCKED"})
+_STEP_ERROR_LIMIT = 200
+
+
+class Runs:
+    """The ``/v1/runs`` routes."""
+
+    def __init__(self, transport: Transport) -> None:
+        self._transport = transport
+
+    def get(self, run_id: str) -> dict[str, Any]:
+        """The run as it stands: status, steps, timestamps, error."""
+        return self._transport.json(
+            "GET", f"v1/runs/{run_id}", scope="run_read", retry=True
+        )
+
+    def wait(
+        self, run_id: str, *, timeout: float | None = 3600, poll_interval: float = 15
+    ) -> dict[str, Any]:
+        """Poll until the run ends; return it when it ``COMPLETED``.
+
+        Raises :class:`RunFailed` or :class:`RunCancelled` when it ends
+        otherwise, and :class:`WaitTimeout` after ``timeout`` seconds
+        (``None`` waits indefinitely); the run keeps going on the server.
+        A server restarting during a deploy (502/503/504 or no
+        connection) is waited out, not raised.
+        """
+        if poll_interval < 0:
+            msg = "poll_interval must not be negative"
+            raise ValueError(msg)
+        deadline = None if timeout is None else time.monotonic() + timeout
+        status: str | None = None
+        while True:
+            run = self._poll(run_id)
+            if run is not None:
+                status = run.get("status")
+                if status not in _RUNNING:
+                    return _settled(run)
+            if deadline is not None and time.monotonic() >= deadline:
+                msg = (
+                    f"run {run_id} still {status} after {timeout}s; "
+                    "it keeps going on the server"
+                )
+                raise WaitTimeout(
+                    msg, run_id=run_id, timeout=timeout or 0, last_status=status
+                )
+            pause = poll_interval
+            if deadline is not None:
+                pause = max(0.0, min(pause, deadline - time.monotonic()))
+            logger.debug("run %s is %s; polling in %.1fs", run_id, status, pause)
+            time.sleep(pause)
+
+    def results(self, run_id: str) -> dict[str, Any]:
+        """The ended run's results: ``results`` per step, ``marked_results``."""
+        return self._transport.json(
+            "GET",
+            f"v1/runs/{run_id}/results",
+            scope="run_read",
+            hints={httpx.codes.CONFLICT: "the run is still running"},
+            retry=True,
+        )
+
+    def usage(self, run_id: str) -> dict[str, Any]:
+        """The run's model usage and cost."""
+        return self._transport.json(
+            "GET", f"v1/runs/{run_id}/usage", scope="run_read", retry=True
+        )
+
+    def requests(self, run_id: str) -> list[dict[str, Any]]:
+        """The review requests the run raised, pending and resolved."""
+        return self._transport.json(
+            "GET", f"v1/runs/{run_id}/hitl", scope="inbox_read", retry=True
+        )
+
+    def cancel(self, run_id: str) -> None:
+        """Ask the server to cancel the run; it moves to ``CANCELLING``."""
+        self._transport.request(
+            "POST",
+            f"v1/runs/{run_id}/cancel",
+            scope="run_cancel",
+            hints={httpx.codes.CONFLICT: "the run has already finished"},
+        )
+
+    def _poll(self, run_id: str) -> dict[str, Any] | None:
+        """One read, or ``None`` when the server is briefly unavailable."""
+        try:
+            return self.get(run_id)
+        except NetworkError:
+            logger.debug("run %s: server unreachable, waiting", run_id)
+        except ApiError as exc:
+            if exc.status not in _TRANSIENT:
+                raise
+            logger.debug("run %s: server answered %s, waiting", run_id, exc.status)
+        return None
+
+
+class Run:
+    """A handle on one run: ``client.runs`` with the id filled in.
+
+    ``status`` is the status from this handle's last read.
+    """
+
+    def __init__(self, runs: Runs, run_id: str) -> None:
+        self._runs = runs
+        self.id = run_id
+        self.status: str | None = None
+
+    def __repr__(self) -> str:
+        return f"Run(id={self.id!r}, status={self.status!r})"
+
+    def get(self) -> dict[str, Any]:
+        return self._read(self._runs.get(self.id))
+
+    def wait(
+        self, *, timeout: float | None = 3600, poll_interval: float = 15
+    ) -> dict[str, Any]:
+        try:
+            return self._read(
+                self._runs.wait(self.id, timeout=timeout, poll_interval=poll_interval)
+            )
+        except (RunFailed, RunCancelled) as exc:
+            self._read(exc.run)
+            raise
+        except WaitTimeout as exc:
+            self.status = exc.last_status
+            raise
+
+    def results(self) -> dict[str, Any]:
+        return self._runs.results(self.id)
+
+    def usage(self) -> dict[str, Any]:
+        return self._runs.usage(self.id)
+
+    def requests(self) -> list[dict[str, Any]]:
+        return self._runs.requests(self.id)
+
+    def cancel(self) -> None:
+        self._runs.cancel(self.id)
+
+    def _read(self, run: dict[str, Any]) -> dict[str, Any]:
+        self.status = run.get("status")
+        return run
+
+
+def _settled(run: dict[str, Any]) -> dict[str, Any]:
+    status = run.get("status")
+    run_id = run.get("id", "")
+    if status == "FAILED":
+        failed = [
+            f"{step.get('step_name')}: {step.get('error_type') or 'error'}: "
+            f"{(step.get('error_message') or '')[:_STEP_ERROR_LIMIT]}"
+            for step in run.get("steps") or []
+            if step.get("status") in _FAILED_STEP
+        ]
+        msg = f"run {run_id} failed" + (f": {'; '.join(failed)}" if failed else "")
+        raise RunFailed(msg, run=run)
+    if status == "CANCELLED":
+        msg = f"run {run_id} was cancelled"
+        raise RunCancelled(msg, run=run)
+    return run

tidefold_client-0.0.226/tidefold_client/_transport.py

@@ -0,0 +1,260 @@
+"""One HTTP session against one tidefold API: URLs, auth, retries, errors.
+
+The token is attached per request, never as a default header on the
+underlying ``httpx.Client``, so a signed upload URL and a caller-supplied
+client never carry it.
+"""
+
+import json
+import logging
+import re
+import time
+from collections.abc import Iterator
+from contextlib import contextmanager
+from importlib.metadata import PackageNotFoundError
+from importlib.metadata import version as dist_version
+from typing import Any
+from urllib.parse import urlsplit
+
+import httpx
+
+from tidefold_client._errors import (
+    ApiError,
+    AuthError,
+    Conflict,
+    InvalidRequest,
+    NetworkError,
+    NotFound,
+    PermissionDenied,
+)
+
+logger = logging.getLogger("tidefold_client")
+
+try:
+    CLIENT_VERSION = dist_version("tidefold-client")
+except PackageNotFoundError:  # pragma: no cover - only outside an install
+    CLIENT_VERSION = "0.0.0+unknown"
+
+USER_AGENT = f"tidefold-client/{CLIENT_VERSION}"
+DEFAULT_TIMEOUT_SECONDS = 60.0
+
+_RETRY_ATTEMPTS = 4
+_RETRY_BACKOFF_SECONDS = 0.5
+_DETAIL_LIMIT = 300
+_SEMVER = re.compile(r"^\d+\.\d+\.\d+$")
+
+_INVALID = frozenset(
+    {
+        httpx.codes.BAD_REQUEST,
+        httpx.codes.REQUEST_ENTITY_TOO_LARGE,
+        httpx.codes.UNPROCESSABLE_ENTITY,
+    }
+)
+
+
+class Transport:
+    """Requests against one API root, mapping error statuses to exceptions."""
+
+    def __init__(
+        self,
+        base_url: str,
+        token: str | None,
+        *,
+        http: httpx.Client | None,
+        timeout: float,
+    ) -> None:
+        if not base_url:
+            msg = (
+                "base_url is required: the API root, e.g. https://<host>/api "
+                "or http://localhost:8000"
+            )
+            raise ValueError(msg)
+        self.base = base_url.rstrip("/") + "/"
+        self._token = token
+        self._owns_http = http is None
+        self._http = http if http is not None else httpx.Client(timeout=timeout)
+        self._version_checked = False
+
+    @property
+    def has_token(self) -> bool:
+        return bool(self._token)
+
+    def close(self) -> None:
+        if self._owns_http:
+            self._http.close()
+
+    def url(self, path_or_url: str) -> str:
+        """An absolute URL; a relative one is resolved against the API root.
+
+        A grant URL the API returns relative (``/v1/files/...``) is relative
+        to the API root, not to the host, so ``/api`` on a deployment stays.
+        """
+        if path_or_url.startswith(("http://", "https://")):
+            return path_or_url
+        return self.base + path_or_url.lstrip("/")
+
+    def request(  # noqa: PLR0913 - one keyword per request facet
+        self,
+        method: str,
+        path: str,
+        *,
+        scope: str | None = None,
+        hints: dict[int, str] | None = None,
+        retry: bool = False,
+        auth: bool = True,
+        json_body: dict[str, Any] | None = None,
+        content: bytes | None = None,
+        headers: dict[str, str] | None = None,
+    ) -> httpx.Response:
+        """Send one request; raise the mapped error for an error status."""
+        self.check_server_version()
+        target = self.url(path)
+        response = self._send(
+            method,
+            target,
+            retry=retry,
+            auth=auth,
+            json_body=json_body,
+            content=content,
+            headers=headers,
+        )
+        if response.is_error:
+            raise_for_status(response, method, scope=scope, hints=hints)
+        return response
+
+    def json(
+        self,
+        method: str,
+        path: str,
+        *,
+        scope: str | None = None,
+        hints: dict[int, str] | None = None,
+        retry: bool = False,
+        json_body: dict[str, Any] | None = None,
+    ) -> Any:  # noqa: ANN401 - the API's JSON, passed through as is
+        return self.request(
+            method, path, scope=scope, hints=hints, retry=retry, json_body=json_body
+        ).json()
+
+    @contextmanager
+    def stream(self, path: str, *, scope: str | None) -> Iterator[httpx.Response]:
+        """A streamed GET, raising the mapped error before any byte is read."""
+        self.check_server_version()
+        with self._http.stream("GET", self.url(path), headers=self._headers()) as resp:
+            if resp.is_error:
+                resp.read()
+                raise_for_status(resp, "GET", scope=scope)
+            yield resp
+
+    def check_server_version(self) -> None:
+        """Warn once when the server runs a different release than this client.
+
+        Best effort: a server that cannot be read is left to the request
+        that follows, which reports the failure itself.
+        """
+        if self._version_checked:
+            return
+        self._version_checked = True
+        try:
+            server = self._send("GET", self.url("version"), retry=False, auth=False)
+            image_tag = server.json().get("image_tag") if server.is_success else None
+        except (httpx.HTTPError, NetworkError, ValueError, AttributeError):
+            logger.debug("could not read the server version", exc_info=True)
+            return
+        if (
+            isinstance(image_tag, str)
+            and _SEMVER.match(image_tag)
+            and _SEMVER.match(CLIENT_VERSION)
+            and image_tag != CLIENT_VERSION
+        ):
+            logger.warning(
+                "tidefold-client %s is talking to a server on %s; "
+                "install tidefold-client==%s to match it",
+                CLIENT_VERSION,
+                image_tag,
+                image_tag,
+            )
+
+    def server_version(self) -> dict[str, Any]:
+        return self.json("GET", "version", retry=True)
+
+    def _headers(self, *, auth: bool = True) -> dict[str, str]:
+        headers = {"User-Agent": USER_AGENT}
+        if auth and self._token:
+            headers["Authorization"] = f"Bearer {self._token}"
+        return headers
+
+    def _send(
+        self,
+        method: str,
+        target: str,
+        *,
+        retry: bool,
+        auth: bool,
+        json_body: dict[str, Any] | None = None,
+        content: bytes | None = None,
+        headers: dict[str, str] | None = None,
+    ) -> httpx.Response:
+        merged = {**self._headers(auth=auth), **(headers or {})}
+
+        def attempt() -> httpx.Response:
+            return self._http.request(
+                method, target, json=json_body, content=content, headers=merged
+            )
+
+        for retry_number in range(1, _RETRY_ATTEMPTS if retry else 1):
+            try:
+                return attempt()
+            except httpx.TransportError as exc:
+                logger.debug("retrying %s after %s", method, type(exc).__name__)
+                time.sleep(_RETRY_BACKOFF_SECONDS * retry_number)
+        try:
+            return attempt()
+        except httpx.TransportError as exc:
+            msg = f"{method} {urlsplit(target).path}: {type(exc).__name__}: {exc}"
+            raise NetworkError(msg) from exc
+
+
+def raise_for_status(
+    response: httpx.Response,
+    method: str,
+    *,
+    scope: str | None = None,
+    hints: dict[int, str] | None = None,
+) -> None:
+    """Raise the exception for an error response."""
+    status = response.status_code
+    path = response.request.url.path
+    detail = _detail(response)
+    message = f"{method} {path} -> {status}: {detail}"
+    hint = (hints or {}).get(status)
+    if hint is None and status == httpx.codes.UNAUTHORIZED:
+        hint = "the token is missing, wrong, expired or revoked"
+    if hint is None and status == httpx.codes.FORBIDDEN and scope:
+        hint = f"this call needs the token scope {scope!r}"
+    if hint:
+        message = f"{message} ({hint})"
+    kind: type[ApiError]
+    if status == httpx.codes.UNAUTHORIZED:
+        kind = AuthError
+    elif status == httpx.codes.FORBIDDEN:
+        kind = PermissionDenied
+    elif status == httpx.codes.NOT_FOUND:
+        kind = NotFound
+    elif status == httpx.codes.CONFLICT:
+        kind = Conflict
+    elif status in _INVALID:
+        kind = InvalidRequest
+    else:
+        kind = ApiError
+    raise kind(message, status=status, method=method, path=path, detail=detail)
+
+
+def _detail(response: httpx.Response) -> str:
+    try:
+        body = response.json()
+    except ValueError:
+        return response.text[:_DETAIL_LIMIT]
+    detail = body.get("detail", body) if isinstance(body, dict) else body
+    text = detail if isinstance(detail, str) else json.dumps(detail)
+    return text[:_DETAIL_LIMIT]

tidefold_client-0.0.226/tidefold_client/_workflows.py

@@ -0,0 +1,125 @@
+"""``client.workflows``: find workflows and start runs of them."""
+
+import os
+from collections.abc import Mapping, Sequence
+from pathlib import Path
+from typing import Any, Literal
+
+import httpx
+
+from tidefold_client._errors import NotFound
+from tidefold_client._files import FilePath, Files
+from tidefold_client._runs import Run, Runs
+from tidefold_client._transport import Transport
+
+type FileInputs = Mapping[str, FilePath | Sequence[FilePath]]
+
+_START_HINTS: dict[int, str] = {
+    httpx.codes.NOT_FOUND: (
+        "no such workflow, or its category is not among the token's attributes"
+    ),
+    httpx.codes.CONFLICT: (
+        "the workflow has never been published, or its spec cannot run"
+    ),
+}
+
+
+class Workflows:
+    """The ``/v1/workflows`` routes."""
+
+    def __init__(self, transport: Transport, *, files: Files, runs: Runs) -> None:
+        self._transport = transport
+        self._files = files
+        self._runs = runs
+        self._ids: dict[str, str] = {}
+
+    def list(self) -> list[dict[str, Any]]:
+        """Every workflow this token can see, latest version of each."""
+        items = self._transport.json(
+            "GET", "v1/workflows", scope="workflow_read", retry=True
+        )
+        self._ids.update({item["name"]: item["id"] for item in items})
+        return items
+
+    def get_id(self, name: str) -> str:
+        """The stable id of the workflow whose ``metadata.name`` is ``name``.
+
+        Cached per client: a workflow's id stays the same across versions.
+        """
+        if name not in self._ids:
+            self.list()
+        if name not in self._ids:
+            msg = f"no workflow named {name!r} is visible to this token"
+            raise NotFound(
+                msg, status=404, method="GET", path="/v1/workflows", detail=msg
+            )
+        return self._ids[name]
+
+    def start(
+        self,
+        workflow: str | None = None,
+        *,
+        workflow_id: str | None = None,
+        inputs: Mapping[str, str] | None = None,
+        files: FileInputs | None = None,
+        subject: str | None = None,
+        correlation_id: str | None = None,
+        channel: Literal["published", "draft"] = "published",
+    ) -> Run:
+        """Upload ``files``, start a run of the workflow, return it unawaited.
+
+        ``workflow`` is the workflow's ``metadata.name``; ``workflow_id``
+        its stable id. Give exactly one. ``inputs`` are the data inputs,
+        all strings. ``files`` maps a file input to one path or a list of
+        paths. ``correlation_id`` is the caller's own reference; it does
+        not deduplicate, so starting twice starts two runs.
+        """
+        if (workflow is None) == (workflow_id is None):
+            msg = "give exactly one of workflow (its name) or workflow_id"
+            raise ValueError(msg)
+        data = _data_inputs(inputs)
+        file_paths = _file_inputs(files)
+        target = workflow_id or self.get_id(workflow or "")
+        body: dict[str, Any] = {
+            "data_inputs": data,
+            "file_inputs": [
+                {"name": name, "file_id": self._files.upload(path)["id"]}
+                for name, path in file_paths
+            ],
+            "channel": channel,
+        }
+        if subject is not None:
+            body["subject"] = subject
+        if correlation_id is not None:
+            body["correlation_id"] = correlation_id
+        created = self._transport.json(
+            "POST",
+            f"v1/workflows/{target}/runs",
+            scope="run_create",
+            hints=_START_HINTS,
+            json_body=body,
+        )
+        return Run(self._runs, created["run_id"])
+
+
+def _data_inputs(inputs: Mapping[str, str] | None) -> dict[str, str]:
+    data = dict(inputs or {})
+    for name, value in data.items():
+        if not isinstance(value, str):
+            msg = f"input {name!r} must be a string, got {type(value).__name__}"
+            raise TypeError(msg)
+    return data
+
+
+def _file_inputs(files: FileInputs | None) -> list[tuple[str, Path]]:
+    """``(input name, path)`` pairs, every path checked before any upload."""
+    pairs: list[tuple[str, Path]] = []
+    for name, value in (files or {}).items():
+        paths = [value] if isinstance(value, (str, os.PathLike)) else list(value)
+        for raw in paths:
+            path = Path(raw)
+            if not path.is_file():
+                msg = f"file input {name!r}: {path} is not a file"
+                raise FileNotFoundError(msg)
+            pairs.append((name, path))
+    return pairs