polyai-adk 0.1.0__tar.gz

polyai_adk-0.1.0/LICENSE

@@ -0,0 +1,199 @@
+
+                                 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 the 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 the 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 any 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.
+
+   Copyright 2026 PolyAI Limited
+
+   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.

polyai_adk-0.1.0/PKG-INFO

@@ -0,0 +1,248 @@
+Metadata-Version: 2.4
+Name: polyai-adk
+Version: 0.1.0
+Summary: Agent Development Kit (ADK) — a CLI for managing Agent Studio projects locally
+Requires-Python: >=3.14.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: protobuf>=4.21.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: ruamel.yaml>=0.18.0
+Requires-Dist: simple-term-menu==1.4.1
+Requires-Dist: jsonschema>=4.20.0
+Requires-Dist: requests==2.31.0
+Requires-Dist: python-dateutil==2.8.2
+Requires-Dist: ruff>=0.14.0
+Requires-Dist: ty
+Provides-Extra: dev
+Requires-Dist: pre-commit>=3.0.0; extra == "dev"
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: tomli-w>=1.0.0; extra == "dev"
+Dynamic: license-file
+
+![PolyAI](logo.png)
+
+# Agent Development Kit (ADK)
+
+[![PyPI version](https://img.shields.io/pypi/v/polyai-adk)](https://pypi.org/project/polyai-adk/)
+[![Python version](https://img.shields.io/pypi/pyversions/polyai-adk)](https://pypi.org/project/polyai-adk/)
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![Develop with Claude Code](https://img.shields.io/badge/Develop%20with-Claude%20Code-DC9E63?logo=claude)](https://claude.ai/download)
+
+A CLI and Python package for managing [Agent Studio](https://studio.us.poly.ai) projects locally. It provides a Git-like workflow for synchronizing project configurations between your local filesystem and the Agent Studio platform.
+
+## Prerequisites
+
+You must have access to a workspace in PolyAI Agent Studio before using this tool. Access and an API key are provided by your PolyAI contact. To request access to the PolyAI platform, reach out to [developers@poly-ai.com](mailto:developers@poly-ai.com).
+
+## Installation
+
+```bash
+pip install polyai-adk
+```
+
+Once installed, use the `poly` command to manage your projects:
+
+```bash
+poly init       # Initialize a project (interactive)
+poly pull       # Pull latest configuration
+poly push       # Push local changes
+poly status     # View project status
+poly diff       # View local changes
+poly branch     # Manage branches
+poly format     # Format resources
+poly validate   # Validate configuration
+poly review     # Create a review gist
+```
+
+## Usage
+A whitelisted API key is needed to run any of the poly commands.
+
+1. Create an API key at https://studio.[us/uk/eu].poly.ai/<account-name>/data-access
+2. Contact an engineer from the developer platform team team to whitelist your API key on Kong
+3. Add the key to your env variable (typically ~/.zshrc or ~/.bashrc), and name it POLY_ADK_KEY
+
+Once you do that, you'll be able to access agents under the <account-name> for the namespace in which the API key is generated.
+
+*We are in the process of automating the whitelisting of the API key, and limiting the external ADK to just the production namespace.*
+
+## Usage
+
+Run `poly --help` to see all available commands and options. Each command also supports `--help` for detailed syntax (e.g. `poly push --help`).
+
+### `poly init`
+
+Initialize a new Agent Studio project locally. Runs interactively by default, prompting for region, account, and project. You can also pass these directly:
+
+```bash
+poly init
+poly init --region us-1 --account_id 123 --project_id my_project
+poly init --base-path /path/to/projects
+poly init --format   # format resources after init
+```
+
+### `poly pull`
+
+Pull the latest project configuration from Agent Studio:
+
+```bash
+poly pull
+poly pull --force     # overwrite all local changes
+poly pull --format    # format resources after pulling
+```
+
+### `poly push`
+
+Push local changes to Agent Studio:
+
+```bash
+poly push
+poly push --dry-run          # preview what would be pushed
+poly push --skip-validation  # skip local validation before pushing
+poly push --force            # overwrite remote changes
+poly push --format           # format resources before pushing
+```
+
+### `poly status`
+
+View changed, new, and deleted files in your project:
+
+```bash
+poly status
+```
+
+### `poly diff`
+
+Show diffs between your local project and the remote version:
+
+```bash
+poly diff              # all changes
+poly diff file1.yaml   # specific files
+```
+
+### `poly revert`
+
+Revert local changes:
+
+```bash
+poly revert --all                  # revert everything
+poly revert file1.yaml file2.yaml  # revert specific files
+```
+
+### `poly branch`
+
+Manage branches (default branch is `main`):
+
+```bash
+poly branch list
+poly branch current
+poly branch create my-feature
+poly branch switch my-feature
+poly branch switch my-feature --force  # discard uncommitted changes
+```
+
+### `poly format`
+
+Format project resources (Python via ruff, YAML/JSON via in-process formatting). Use `--check` to only report files that would change; use `--ty` to also run type checking.
+
+```bash
+poly format              # all resources
+poly format file1.py     # specific files
+poly format --check      # check only, no writes
+```
+
+### `poly validate`
+
+Validate project configuration locally:
+
+```bash
+poly validate
+```
+
+### `poly review`
+
+Create a GitHub gist for reviewing changes, similar to a pull request:
+
+```bash
+poly review                                      # local vs remote
+poly review --before main --after feature-branch  # compare branches
+poly review --delete                              # delete all review gists
+```
+
+### `poly chat`
+
+Start an interactive chat session with your agent:
+
+```bash
+poly chat
+poly chat --environment live
+poly chat --channel webchat
+poly chat --metadata   # show functions, flows, and state each turn
+```
+
+## Development Setup
+
+### Prerequisites
+
+- Python 3.14 or higher
+- [uv](https://github.com/astral-sh/uv) (`brew install uv`)
+
+### Getting Started
+
+```bash
+git clone https://github.com/PolyAI-LDN/local_agent_studio.git
+cd local_agent_studio
+uv venv
+source .venv/bin/activate
+uv pip install -e ".[dev]"
+pre-commit install
+```
+
+### Running Tests
+
+```bash
+pytest
+```
+
+Test files are located in `src/poly/tests/`.
+
+### Project Structure
+
+- `src/poly/cli.py` - CLI interface
+- `src/poly/project.py` - Core project management
+- `src/poly/resources/` - Resource type implementations
+- `src/poly/handlers/` - API handler implementations
+- `src/poly/tests/` - Test suite
+- `src/poly/types/` - Python type definitions for the Agent Studio runtime
+
+## Bugs & Feature Requests
+
+Please report bugs or request features via the [GitHub Issues](https://github.com/PolyAI-LDN/local_agent_studio/issues) page.
+
+## Contributing
+
+Contributions are welcome! The project uses **ruff** for linting/formatting (enforced via pre-commit hooks) and **pytest** for testing. Please ensure all tests pass before submitting a pull request.
+
+We recommend using [Claude Code](https://claude.ai/download) for development. The repo includes a `.claude/` directory with project-specific instructions and permissions pre-configured.
+
+## Releases
+
+This project uses [python-semantic-release](https://python-semantic-release.readthedocs.io/) to automate versioning and publishing. Version bumps are determined from [conventional commit](https://www.conventionalcommits.org/) messages:
+
+| Commit prefix | Version bump | Example |
+|---|---|---|
+| `fix:` | Patch (2.0.4 → 2.0.5) | `fix: handle missing config file` |
+| `feat:` | Minor (2.0.4 → 2.1.0) | `feat: add poly export command` |
+| `feat!:` / `BREAKING CHANGE:` | Major (2.0.4 → 3.0.0) | `feat!: redesign resource schema` |
+| `chore:`, `docs:`, `ci:` | No release | `docs: update README` |
+
+When a commit is merged to `main`, the release workflow automatically:
+
+1. Determines the next version from commit history
+2. Updates the version in `pyproject.toml`
+3. Creates a git tag and GitHub Release
+
+## License
+
+This project is licensed under the Apache License 2.0. See the [LICENSE](LICENSE) file for details.

polyai_adk-0.1.0/README.md

@@ -0,0 +1,226 @@
+![PolyAI](logo.png)
+
+# Agent Development Kit (ADK)
+
+[![PyPI version](https://img.shields.io/pypi/v/polyai-adk)](https://pypi.org/project/polyai-adk/)
+[![Python version](https://img.shields.io/pypi/pyversions/polyai-adk)](https://pypi.org/project/polyai-adk/)
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![Develop with Claude Code](https://img.shields.io/badge/Develop%20with-Claude%20Code-DC9E63?logo=claude)](https://claude.ai/download)
+
+A CLI and Python package for managing [Agent Studio](https://studio.us.poly.ai) projects locally. It provides a Git-like workflow for synchronizing project configurations between your local filesystem and the Agent Studio platform.
+
+## Prerequisites
+
+You must have access to a workspace in PolyAI Agent Studio before using this tool. Access and an API key are provided by your PolyAI contact. To request access to the PolyAI platform, reach out to [developers@poly-ai.com](mailto:developers@poly-ai.com).
+
+## Installation
+
+```bash
+pip install polyai-adk
+```
+
+Once installed, use the `poly` command to manage your projects:
+
+```bash
+poly init       # Initialize a project (interactive)
+poly pull       # Pull latest configuration
+poly push       # Push local changes
+poly status     # View project status
+poly diff       # View local changes
+poly branch     # Manage branches
+poly format     # Format resources
+poly validate   # Validate configuration
+poly review     # Create a review gist
+```
+
+## Usage
+A whitelisted API key is needed to run any of the poly commands.
+
+1. Create an API key at https://studio.[us/uk/eu].poly.ai/<account-name>/data-access
+2. Contact an engineer from the developer platform team team to whitelist your API key on Kong
+3. Add the key to your env variable (typically ~/.zshrc or ~/.bashrc), and name it POLY_ADK_KEY
+
+Once you do that, you'll be able to access agents under the <account-name> for the namespace in which the API key is generated.
+
+*We are in the process of automating the whitelisting of the API key, and limiting the external ADK to just the production namespace.*
+
+## Usage
+
+Run `poly --help` to see all available commands and options. Each command also supports `--help` for detailed syntax (e.g. `poly push --help`).
+
+### `poly init`
+
+Initialize a new Agent Studio project locally. Runs interactively by default, prompting for region, account, and project. You can also pass these directly:
+
+```bash
+poly init
+poly init --region us-1 --account_id 123 --project_id my_project
+poly init --base-path /path/to/projects
+poly init --format   # format resources after init
+```
+
+### `poly pull`
+
+Pull the latest project configuration from Agent Studio:
+
+```bash
+poly pull
+poly pull --force     # overwrite all local changes
+poly pull --format    # format resources after pulling
+```
+
+### `poly push`
+
+Push local changes to Agent Studio:
+
+```bash
+poly push
+poly push --dry-run          # preview what would be pushed
+poly push --skip-validation  # skip local validation before pushing
+poly push --force            # overwrite remote changes
+poly push --format           # format resources before pushing
+```
+
+### `poly status`
+
+View changed, new, and deleted files in your project:
+
+```bash
+poly status
+```
+
+### `poly diff`
+
+Show diffs between your local project and the remote version:
+
+```bash
+poly diff              # all changes
+poly diff file1.yaml   # specific files
+```
+
+### `poly revert`
+
+Revert local changes:
+
+```bash
+poly revert --all                  # revert everything
+poly revert file1.yaml file2.yaml  # revert specific files
+```
+
+### `poly branch`
+
+Manage branches (default branch is `main`):
+
+```bash
+poly branch list
+poly branch current
+poly branch create my-feature
+poly branch switch my-feature
+poly branch switch my-feature --force  # discard uncommitted changes
+```
+
+### `poly format`
+
+Format project resources (Python via ruff, YAML/JSON via in-process formatting). Use `--check` to only report files that would change; use `--ty` to also run type checking.
+
+```bash
+poly format              # all resources
+poly format file1.py     # specific files
+poly format --check      # check only, no writes
+```
+
+### `poly validate`
+
+Validate project configuration locally:
+
+```bash
+poly validate
+```
+
+### `poly review`
+
+Create a GitHub gist for reviewing changes, similar to a pull request:
+
+```bash
+poly review                                      # local vs remote
+poly review --before main --after feature-branch  # compare branches
+poly review --delete                              # delete all review gists
+```
+
+### `poly chat`
+
+Start an interactive chat session with your agent:
+
+```bash
+poly chat
+poly chat --environment live
+poly chat --channel webchat
+poly chat --metadata   # show functions, flows, and state each turn
+```
+
+## Development Setup
+
+### Prerequisites
+
+- Python 3.14 or higher
+- [uv](https://github.com/astral-sh/uv) (`brew install uv`)
+
+### Getting Started
+
+```bash
+git clone https://github.com/PolyAI-LDN/local_agent_studio.git
+cd local_agent_studio
+uv venv
+source .venv/bin/activate
+uv pip install -e ".[dev]"
+pre-commit install
+```
+
+### Running Tests
+
+```bash
+pytest
+```
+
+Test files are located in `src/poly/tests/`.
+
+### Project Structure
+
+- `src/poly/cli.py` - CLI interface
+- `src/poly/project.py` - Core project management
+- `src/poly/resources/` - Resource type implementations
+- `src/poly/handlers/` - API handler implementations
+- `src/poly/tests/` - Test suite
+- `src/poly/types/` - Python type definitions for the Agent Studio runtime
+
+## Bugs & Feature Requests
+
+Please report bugs or request features via the [GitHub Issues](https://github.com/PolyAI-LDN/local_agent_studio/issues) page.
+
+## Contributing
+
+Contributions are welcome! The project uses **ruff** for linting/formatting (enforced via pre-commit hooks) and **pytest** for testing. Please ensure all tests pass before submitting a pull request.
+
+We recommend using [Claude Code](https://claude.ai/download) for development. The repo includes a `.claude/` directory with project-specific instructions and permissions pre-configured.
+
+## Releases
+
+This project uses [python-semantic-release](https://python-semantic-release.readthedocs.io/) to automate versioning and publishing. Version bumps are determined from [conventional commit](https://www.conventionalcommits.org/) messages:
+
+| Commit prefix | Version bump | Example |
+|---|---|---|
+| `fix:` | Patch (2.0.4 → 2.0.5) | `fix: handle missing config file` |
+| `feat:` | Minor (2.0.4 → 2.1.0) | `feat: add poly export command` |
+| `feat!:` / `BREAKING CHANGE:` | Major (2.0.4 → 3.0.0) | `feat!: redesign resource schema` |
+| `chore:`, `docs:`, `ci:` | No release | `docs: update README` |
+
+When a commit is merged to `main`, the release workflow automatically:
+
+1. Determines the next version from commit history
+2. Updates the version in `pyproject.toml`
+3. Creates a git tag and GitHub Release
+
+## License
+
+This project is licensed under the Apache License 2.0. See the [LICENSE](LICENSE) file for details.