liyagent 0.2.0__tar.gz

liyagent-0.2.0/CHANGELOG.md

@@ -0,0 +1,21 @@
+# Changelog
+
+All notable changes to the `liyagent` Python package. Versions follow
+semantic versioning.
+
+## 0.2.0 — 2026-11-05
+
+- Release-ready package metadata (classifiers, URLs, `py.typed`), the
+  version read from `liyagent.__version__`, and a GitHub Actions release to
+  PyPI by trusted publishing.
+- Typed request bodies (`liyagent.models`: a `TypedDict` per body and
+  `REQUEST_BODIES`) generated from the server's OpenAPI document.
+- `templates.install(..., params=)` sends template parameters.
+- Authoring the tenant's own templates: `templates.authored`,
+  `authored_versions`, `validate`, `draft_from_agent`, `save_draft`,
+  `publish`, `delete_draft`, `withdraw`.
+
+## 0.1.0
+
+- First version: agents, runs, evals, knowledge, approvals and solution
+  templates over httpx; `check_server()`.

liyagent-0.2.0/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.

liyagent-0.2.0/MANIFEST.in

@@ -0,0 +1,2 @@
+include README.md CHANGELOG.md
+recursive-include examples *.py

liyagent-0.2.0/PKG-INFO

@@ -0,0 +1,126 @@
+Metadata-Version: 2.4
+Name: liyagent
+Version: 0.2.0
+Summary: Python SDK for Liyagent: agents, runs, evals, knowledge, approvals and solution templates
+Author: Liyagent
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://liyagent.com
+Keywords: liyagent,ai agents,agent platform,itsm,sdk
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+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
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.25
+Provides-Extra: test
+Requires-Dist: pytest>=7; extra == "test"
+Dynamic: license-file
+
+# Liyagent Python SDK
+
+A small client for Liyagent's public API: agents, runs, evals, knowledge,
+approvals and solution templates. It depends only on `httpx` and returns the
+server's JSON as it is.
+
+```bash
+pip install liyagent          # from PyPI, once released
+pip install ./sdk/python      # from this repository
+```
+
+Python 3.10+. Versioned with the package (`liyagent.__version__`); see
+`CHANGELOG.md`.
+
+## Sign in
+
+```python
+from liyagent import Client
+
+# A service account (what a pipeline uses): exchanged for a one-hour session,
+# and for a new one when it expires.
+liya = Client("https://acme.liyagent.com", token="svc/ci-deployer:...")
+
+# A person, as the console signs in.
+liya = Client("https://acme.liyagent.com", username="ana", password="...")
+
+# The machine surface (knowledge.answer): the instance API key or a client token.
+liya = Client("https://acme.liyagent.com", api_key="...")
+```
+
+`LIYA_URL`, `LIYA_TOKEN` (or `TICKETIQ_TOKEN`) and `LIYA_API_KEY` are read
+when the arguments are left out, as the `liya` CLI reads them.
+
+## What it covers
+
+| Namespace | Calls |
+| --- | --- |
+| `liya.agents` | `list`, `get`, `put`, `delete`, `export`, `apply` (agents as code), `ask`, `start`, `stop`, `workflows`, `run_workflow`, `workflow_run` |
+| `liya.runs` | `list`, `checkpoint`, `resume` |
+| `liya.evals` | `datasets`, `dataset`, `create_dataset`, `start_run`, `runs`, `run`, `compare`, `wait` |
+| `liya.knowledge` | `answer`, `collections`, `articles`, `approve_article`, `reject_article` |
+| `liya.approvals` | `list`, `get`, `approve`, `reject` |
+| `liya.templates` | `list`, `get`, `preview`, `install` (with `params`), `installs`, `uninstall` |
+| `liya.templates` (authoring, `templates.write`) | `authored`, `authored_versions`, `validate`, `draft_from_agent`, `save_draft`, `publish`, `delete_draft`, `withdraw` |
+
+Anything else: `liya.request("GET", "/api/...")`, with the same credentials
+and errors.
+
+## Types
+
+Request bodies are typed: `liyagent.models` holds a `TypedDict` per body
+(`TemplateInstallBody`, `BundleApplyBody`, …) and `REQUEST_BODIES` maps each
+operation to its body. They are generated from the server's OpenAPI document
+by `sdk/scripts/generate_models.py`, and the server's test suite fails when
+the committed file differs from what the document says. The package ships
+`py.typed`, so mypy and pyright read them. Responses are the server's JSON
+as it is.
+
+## Your own templates
+
+```python
+doc = liya.templates.draft_from_agent("desk-helper", key="desk-answers")["template"]
+doc["params"] = [{"name": "team", "label": "Escalation team", "required": True}]
+doc["agent"]["instructions"] += "\nEscalate to {{ params.team }}."
+assert liya.templates.validate(doc)["ok"]
+liya.templates.save_draft(doc)
+liya.templates.publish("desk-answers", doc["version"])
+liya.templates.install("desk-answers", agent_id="desk-two", params={"team": "Network"})
+```
+
+## Errors
+
+A refusal raises `LiyagentError` with `status`, the server's `detail` (for a
+bundle or template refusal, `{message, at}`: where in the document it was)
+and a `kind`: `auth` (401, sign in again), `forbidden` (403, a permission is
+missing), `not_found`, `invalid` (400, 422), `conflict` (409, 412),
+`unreachable` or `error`.
+
+## Check the server
+
+`liya.check_server()` lists the operations this SDK uses that the server
+does not serve, so a pipeline can stop before it calls a route an older
+release does not have. The same list (`liyagent.OPERATIONS`) is checked
+against the server's OpenAPI document in the server's test suite
+(`tests/unit/test_sdk_python.py`).
+
+## Examples
+
+- `examples/install_template.py` — preview a template, stop if any part would
+  be refused, install it.
+- `examples/eval_gate.py` — score an agent on its eval set and fail a build
+  that is worse than the pinned baseline.
+- `examples/approvals_queue.py` — work the approval queue from a terminal.
+
+## Releasing
+
+See `sdk/RELEASING.md`: a tag `sdk-py-vX.Y.Z` builds and publishes this
+package to PyPI from GitHub Actions (`.github/workflows/sdk-release.yml`)
+by trusted publishing.

liyagent-0.2.0/README.md

@@ -0,0 +1,99 @@
+# Liyagent Python SDK
+
+A small client for Liyagent's public API: agents, runs, evals, knowledge,
+approvals and solution templates. It depends only on `httpx` and returns the
+server's JSON as it is.
+
+```bash
+pip install liyagent          # from PyPI, once released
+pip install ./sdk/python      # from this repository
+```
+
+Python 3.10+. Versioned with the package (`liyagent.__version__`); see
+`CHANGELOG.md`.
+
+## Sign in
+
+```python
+from liyagent import Client
+
+# A service account (what a pipeline uses): exchanged for a one-hour session,
+# and for a new one when it expires.
+liya = Client("https://acme.liyagent.com", token="svc/ci-deployer:...")
+
+# A person, as the console signs in.
+liya = Client("https://acme.liyagent.com", username="ana", password="...")
+
+# The machine surface (knowledge.answer): the instance API key or a client token.
+liya = Client("https://acme.liyagent.com", api_key="...")
+```
+
+`LIYA_URL`, `LIYA_TOKEN` (or `TICKETIQ_TOKEN`) and `LIYA_API_KEY` are read
+when the arguments are left out, as the `liya` CLI reads them.
+
+## What it covers
+
+| Namespace | Calls |
+| --- | --- |
+| `liya.agents` | `list`, `get`, `put`, `delete`, `export`, `apply` (agents as code), `ask`, `start`, `stop`, `workflows`, `run_workflow`, `workflow_run` |
+| `liya.runs` | `list`, `checkpoint`, `resume` |
+| `liya.evals` | `datasets`, `dataset`, `create_dataset`, `start_run`, `runs`, `run`, `compare`, `wait` |
+| `liya.knowledge` | `answer`, `collections`, `articles`, `approve_article`, `reject_article` |
+| `liya.approvals` | `list`, `get`, `approve`, `reject` |
+| `liya.templates` | `list`, `get`, `preview`, `install` (with `params`), `installs`, `uninstall` |
+| `liya.templates` (authoring, `templates.write`) | `authored`, `authored_versions`, `validate`, `draft_from_agent`, `save_draft`, `publish`, `delete_draft`, `withdraw` |
+
+Anything else: `liya.request("GET", "/api/...")`, with the same credentials
+and errors.
+
+## Types
+
+Request bodies are typed: `liyagent.models` holds a `TypedDict` per body
+(`TemplateInstallBody`, `BundleApplyBody`, …) and `REQUEST_BODIES` maps each
+operation to its body. They are generated from the server's OpenAPI document
+by `sdk/scripts/generate_models.py`, and the server's test suite fails when
+the committed file differs from what the document says. The package ships
+`py.typed`, so mypy and pyright read them. Responses are the server's JSON
+as it is.
+
+## Your own templates
+
+```python
+doc = liya.templates.draft_from_agent("desk-helper", key="desk-answers")["template"]
+doc["params"] = [{"name": "team", "label": "Escalation team", "required": True}]
+doc["agent"]["instructions"] += "\nEscalate to {{ params.team }}."
+assert liya.templates.validate(doc)["ok"]
+liya.templates.save_draft(doc)
+liya.templates.publish("desk-answers", doc["version"])
+liya.templates.install("desk-answers", agent_id="desk-two", params={"team": "Network"})
+```
+
+## Errors
+
+A refusal raises `LiyagentError` with `status`, the server's `detail` (for a
+bundle or template refusal, `{message, at}`: where in the document it was)
+and a `kind`: `auth` (401, sign in again), `forbidden` (403, a permission is
+missing), `not_found`, `invalid` (400, 422), `conflict` (409, 412),
+`unreachable` or `error`.
+
+## Check the server
+
+`liya.check_server()` lists the operations this SDK uses that the server
+does not serve, so a pipeline can stop before it calls a route an older
+release does not have. The same list (`liyagent.OPERATIONS`) is checked
+against the server's OpenAPI document in the server's test suite
+(`tests/unit/test_sdk_python.py`).
+
+## Examples
+
+- `examples/install_template.py` — preview a template, stop if any part would
+  be refused, install it.
+- `examples/eval_gate.py` — score an agent on its eval set and fail a build
+  that is worse than the pinned baseline.
+- `examples/approvals_queue.py` — work the approval queue from a terminal.
+
+## Releasing
+
+See `sdk/RELEASING.md`: a tag `sdk-py-vX.Y.Z` builds and publishes this
+package to PyPI from GitHub Actions (`.github/workflows/sdk-release.yml`)
+by trusted publishing.

liyagent-0.2.0/examples/approvals_queue.py

@@ -0,0 +1,25 @@
+"""Work the approval queue from a script: list what waits, show each held
+call, and approve or reject it by its digest (so an edit made since you read
+it refuses the decision rather than approving something else).
+
+    LIYA_URL=... LIYA_TOKEN=... python approvals_queue.py
+"""
+
+from liyagent import Client
+
+
+def main() -> None:
+    with Client() as liya:
+        for item in liya.approvals.list(status="pending"):
+            print(f"{item['id']}: {item.get('agent')} wants {item.get('tool')} "
+                  f"({item.get('summary', '')})")
+            answer = input("approve, reject or skip? ").strip().lower()
+            if answer == "approve":
+                liya.approvals.approve(item["id"], digest=item.get("digest", ""))
+            elif answer == "reject":
+                liya.approvals.reject(item["id"], reason=input("why? "),
+                                      digest=item.get("digest", ""))
+
+
+if __name__ == "__main__":
+    main()

liyagent-0.2.0/examples/eval_gate.py

@@ -0,0 +1,21 @@
+"""A CI gate: score an agent on its eval set and fail the build when it does
+worse than the pinned baseline by more than the allowed drop.
+
+    LIYA_URL=... LIYA_TOKEN=svc/ci:... python eval_gate.py it-triage it-triage-evals
+"""
+
+import sys
+
+from liyagent import Client
+
+
+def main(agent: str, dataset: str) -> int:
+    with Client() as liya:
+        started = liya.evals.start_run(dataset, agent, baseline="pinned", allowed_drop=0.05)
+        run = liya.evals.wait(started["run"]["id"], timeout=900)
+        print(f"run {run['id']}: {run['status']}, passed: {run.get('passed')}")
+        return 0 if run["status"] == "completed" and run.get("passed") is not False else 1
+
+
+if __name__ == "__main__":
+    sys.exit(main(sys.argv[1], sys.argv[2]))

liyagent-0.2.0/examples/install_template.py

@@ -0,0 +1,40 @@
+"""Install a solution template from a pipeline: preview it, stop if any part
+would be refused, then install it and print what it created.
+
+    LIYA_URL=https://acme.liyagent.com LIYA_TOKEN=svc/ci:... \
+        python install_template.py it-ticket-triage desk-triage
+"""
+
+import sys
+
+from liyagent import Client, LiyagentError
+
+
+def main(key: str, agent_id: str) -> int:
+    with Client() as liya:
+        missing = liya.check_server()
+        if missing:
+            print("this server is older than the SDK; missing:", ", ".join(missing))
+            return 1
+        plan = liya.templates.preview(key, agent_id=agent_id, tags=["managed_by=pipeline"])
+        if not plan["valid"]:
+            detail = plan["refusal"]["detail"]
+            print(f"refused at {plan['step']}: {detail.get('message', detail)}")
+            return 1
+        for name, action in plan["guardrails"].items():
+            print(f"guardrail {name}: {action}")
+        try:
+            done = liya.templates.install(key, agent_id=agent_id,
+                                          tags=["managed_by=pipeline"])
+        except LiyagentError as e:
+            print(e)
+            return 1
+        rec = done["install"]
+        print(f"installed {rec['template']} {rec['version']} as {rec['agent']}: "
+              f"workflow {rec['workflow']}, eval set {rec['evalset']}, "
+              f"triggers {', '.join(rec['triggers']) or 'none'} (paused)")
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main(sys.argv[1], sys.argv[2] if len(sys.argv) > 2 else ""))

liyagent-0.2.0/liyagent/__init__.py

@@ -0,0 +1,15 @@
+"""Liyagent's Python SDK: agents, runs, evals, knowledge, approvals and
+solution templates over the public API.
+
+    from liyagent import Client
+    liya = Client("https://acme.liyagent.com", token="svc/ci:...")
+"""
+
+from . import models
+from ._transport import LiyagentError
+from ._version import __version__
+from .client import Client, missing_operations
+from .resources import OPERATIONS
+
+__all__ = ["Client", "LiyagentError", "OPERATIONS", "missing_operations", "models",
+           "__version__"]