kubernetes-robin-executor 1.0.0__tar.gz

kubernetes_robin_executor-1.0.0/.gitignore

@@ -0,0 +1,180 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+.env
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+.ruff_cache/
+
+/docs/src/reference
+.DS_Store
+
+# Generated log files
+log.jsonl
+
+# Jupyter notebooks executions in docs.
+docs/**/jupyter_execute
+
+# Temporary files
+tmp_code_*.py
+
+# .NET Development settings
+appsettings.Development.json
+
+# cookiecutter templates
+templates/

kubernetes_robin_executor-1.0.0/LICENSE-CODE

@@ -0,0 +1,114 @@
+MIT License
+
+Copyright (c) Microsoft Corporation.
+Copyright (c) 2024 kiyoung you
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE
+
+---
+
+This project includes code from the autogen project, which is licensed under the MIT License.
+
+Copyright (c) Microsoft Corporation.
+Modification Copyright (c) 2024 kiyoung you(questcollector)
+
+This project is licensed under the MIT License. See the full license text above
+
+---
+
+Third-Party Licenses
+---------------------
+
+This project uses the following third-party dependencies:
+
+1. Kubernetes Python SDK(https://github.com/kubernetes-client/python)
+   Licensed under the Apache License, Version 2.0.
+
+---
+
+2. httpx(https://github.com/encode/httpx)
+   Licensed under BSD 3-Clause "New" or "Revised" License:
+
+Copyright © 2019, Encode OSS Ltd. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+---
+
+3. websockets(https://github.com/python-websockets/websockets)
+   Licensed under the BSD 3-Clause "New" or "Revised" License:
+
+Copyright (c) Aymeric Augustin and contributors
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name of the copyright holder nor the names of its contributors
+      may be used to endorse or promote products derived from this software
+      without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+---
+
+4. PyYAML(https://github.com/yaml/pyyaml)
+   Licensed under the MIT License:
+
+Copyright (c) 2017-2021 Ingy döt Net
+Copyright (c) 2006-2016 Kirill Simonov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

kubernetes_robin_executor-1.0.0/PKG-INFO

@@ -0,0 +1,362 @@
+Metadata-Version: 2.4
+Name: kubernetes-robin-executor
+Version: 1.0.0
+Summary: Kubernetes pod code executor (Robin): Python/shell execution and remote workspace upload for AutoGen-style agents.
+License: MIT License
+        
+        Copyright (c) Microsoft Corporation.
+        Copyright (c) 2024 kiyoung you
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE
+        
+        ---
+        
+        This project includes code from the autogen project, which is licensed under the MIT License.
+        
+        Copyright (c) Microsoft Corporation.
+        Modification Copyright (c) 2024 kiyoung you(questcollector)
+        
+        This project is licensed under the MIT License. See the full license text above
+        
+        ---
+        
+        Third-Party Licenses
+        ---------------------
+        
+        This project uses the following third-party dependencies:
+        
+        1. Kubernetes Python SDK(https://github.com/kubernetes-client/python)
+           Licensed under the Apache License, Version 2.0.
+        
+        ---
+        
+        2. httpx(https://github.com/encode/httpx)
+           Licensed under BSD 3-Clause "New" or "Revised" License:
+        
+        Copyright © 2019, Encode OSS Ltd. All rights reserved.
+        
+        Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+        
+        Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+        
+        Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+        
+        Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+        
+        ---
+        
+        3. websockets(https://github.com/python-websockets/websockets)
+           Licensed under the BSD 3-Clause "New" or "Revised" License:
+        
+        Copyright (c) Aymeric Augustin and contributors
+        
+        Redistribution and use in source and binary forms, with or without
+        modification, are permitted provided that the following conditions are met:
+        
+            * Redistributions of source code must retain the above copyright notice,
+              this list of conditions and the following disclaimer.
+            * Redistributions in binary form must reproduce the above copyright notice,
+              this list of conditions and the following disclaimer in the documentation
+              and/or other materials provided with the distribution.
+            * Neither the name of the copyright holder nor the names of its contributors
+              may be used to endorse or promote products derived from this software
+              without specific prior written permission.
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+        ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+        WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+        
+        ---
+        
+        4. PyYAML(https://github.com/yaml/pyyaml)
+           Licensed under the MIT License:
+        
+        Copyright (c) 2017-2021 Ingy döt Net
+        Copyright (c) 2006-2016 Kirill Simonov
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy of
+        this software and associated documentation files (the "Software"), to deal in
+        the Software without restriction, including without limitation the rights to
+        use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+        of the Software, and to permit persons to whom the Software is furnished to do
+        so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE-CODE
+Keywords: AI,agent,autogen,code-executor,kubernetes,robin
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Requires-Dist: asyncio-atexit>=1.0.1
+Requires-Dist: autogen-core>=0.5.2
+Requires-Dist: httpx
+Requires-Dist: kubernetes>=27.0.0
+Requires-Dist: pyyaml
+Requires-Dist: websockets
+Description-Content-Type: text/markdown
+
+# `KubernetesCommandLineCodeExecutor`
+
+Executor that runs code (Python / shell) **inside a Kubernetes pod**: each block is written as a file on the pod’s workspace volume and executed via `exec` (Kubernetes API + stream).
+
+**PyPI distribution name:** `kubernetes-robin-executor` — install with:
+
+```bash
+pip install kubernetes-robin-executor
+```
+
+**Import path** (unchanged): `autogen_kubernetes.code_executors.kubernetes_commandline_code_executor`. The PyPI name differs from the upstream `autogen-kubernetes` package on purpose. Do not install both in the same environment if they expose the same top-level package layout; this distribution keeps the `autogen_kubernetes` module name for compatibility with existing code.
+
+This file is the **project `readme`** in `pyproject.toml`, so it is what users see on the [PyPI project page](https://pypi.org) for `kubernetes-robin-executor` after you publish.
+
+---
+
+## Cluster connection
+
+| Mode | Behavior |
+|------|----------|
+| **`remote_control_plane` set** (API URL, e.g. `https://IP:6443`) | Uses `KUBE_TOKEN` from the environment (Bearer). Client uses `verify_ssl=False`. |
+| **`remote_control_plane=None`** | Local `kubeconfig` or in-cluster config (`load_kube_config` / `load_incluster_config`). |
+
+---
+
+## Constructor (`__init__`)
+
+Main parameters:
+
+| Parameter | Description |
+|-----------|-------------|
+| `image` | Container image (default `python:3-slim`). |
+| `pod_name` | Fixed pod name; if `None`, generates `robin-code-exec-<uuid>`. |
+| `namespace` | Namespace where the pod is created / listed. |
+| `timeout` | Seconds for exec-based runs (≥ 1). |
+| `work_dir` | Path **inside the pod** mounted as the workspace. |
+| `execution_policies` | Optional: override which languages are **executed** vs only **saved**. |
+| `remote_control_plane` | API server URL for bearer-token mode. |
+| `shared_pvc_name` | If set, the pod uses a shared PVC instead of `emptyDir`. |
+| `node` | Optional: `nodeSelector` `kubernetes.io/hostname`. |
+| `shared_resources` | If `True` and a **Running** pod already exists with the **same** `image`, reuses its name instead of creating a new pod. |
+| `env_vars` | List of `{"key": "...", "value": "..."}` appended to `~/.bashrc` in the pod. |
+
+On construction, pod cleanup is registered with `atexit` and `SIGINT` is handled with `cleanup()`.
+
+---
+
+## Upload code from your machine and call functions in the pod
+
+Besides `execute_code_blocks`, you can **copy Python files into the pod’s `work_dir`** and **invoke callables by name** without putting everything in a single markdown block.
+
+### Recommended flow
+
+1. **`install_pod_dispatcher(default_module="robin_user", runner_filename="executor.py")`** — Uploads an `executor.py` that reads JSON with `function`, `arguments`, and optionally `module`, imports the module, and calls `function(**arguments)`.
+2. **`upload_file_content(relative_path, content)`** or **`upload_from_disk(local_path, remote_prefix="")`** — Copies your `.py` files or project tree into the pod under `work_dir`. `upload_from_disk` skips `__pycache__` and hidden names (`.*`); text files only (UTF-8).
+3. **`execute_tool_function(arguments, func_name, *, module=None, runner_script="executor.py")`** — Uploads a temporary `.json` and runs `python <work_dir>/<runner_script> <json>`.
+
+The interpreter adds the script’s directory to `sys.path`; with `executor.py` in `work_dir`, modules in the same directory (e.g. `robin_user.py`) or packages under `work_dir` can be imported using the right `module` (e.g. `my_package.submodule`).
+
+### Minimal example
+
+```python
+with KubernetesCommandLineCodeExecutor(...) as executor:
+    executor.install_pod_dispatcher(default_module="robin_user")
+    executor.upload_from_disk("/local/path/my_folder")  # contains robin_user.py or your layout
+    r = executor.execute_tool_function(
+        {"name": "Ada"},
+        "greet",
+        module="robin_user",
+    )
+    assert r.exit_code == 0
+```
+
+If you omit `module` in `execute_tool_function`, the dispatcher uses the `default_module` passed to `install_pod_dispatcher`.
+
+### Integration test in this repo
+
+`test_upload_from_disk_and_invoke_long_function` uploads `tests/fixtures/robin_upload_invoke/robin_user.py` and calls `greet` and `run_heavy_pipeline` on the pod (marker `robin_remote`; see `tests/README.md`).
+
+Run it from `autogen-kubernetes/python`:
+
+```bash
+uv run pytest packages/autogen-kubernetes/tests/test_kubernetes_commandline_executor.py::test_upload_from_disk_and_invoke_long_function -m robin_remote -v -s -n0
+```
+
+---
+
+## Public properties
+
+| Member | Type / return | Description |
+|--------|----------------|-------------|
+| `timeout` | `int` | Configured timeout. |
+| `work_dir` | `Path` | Working directory in the pod. |
+| `code_extractor` | `MarkdownCodeExtractor` | Code-block extractor for agent integration. |
+| `execution_policies` | `dict` | Per language: `True` runs, `False` only writes the file. |
+| `pod_name` | `str` | Pod name in use (created or reused). |
+| `namespace` | `str` | Current namespace. |
+| `image` | `str` | Container image. |
+
+---
+
+## Public methods
+
+| Method | Description |
+|--------|-------------|
+| `execute_code_blocks(code_blocks: list[CodeBlock]) -> CommandLineCodeResult` | Uploads and runs (or only saves) each block in order. Returns `exit_code`, `output` (combined stdout/stderr), and `code_file`. |
+| `upload_file_content(relative_path, content) -> str` | Writes text in the pod under `work_dir` / `relative_path`; returns the POSIX path in the pod. |
+| `upload_from_disk(local_path, *, remote_prefix="", encoding="utf-8") -> list[str]` | Uploads a local file or full directory tree; returns paths written in the pod. |
+| `install_pod_dispatcher(*, default_module="robin_user", runner_filename="executor.py") -> str` | Uploads the `executor.py` that dispatches JSON → function calls in the pod. |
+| `execute_tool_function(arguments, func_name, *, module=None, runner_script="executor.py") -> CommandLineCodeResult` | Uploads JSON and runs the runner (default `executor.py` in `work_dir`). Use `install_pod_dispatcher` or your own script in the image. `module` is the dotted import if you do not want the dispatcher’s `default_module`. |
+| `cleanup()` | Deletes the pod in the namespace (404-safe). |
+| `stop()` | Runs the registered cleanup (`delete` pod). |
+| `restart()` | `stop()` then calls `__init__` again with a subset of arguments (**note**: remote mode may omit `remote_control_plane`; prefer recreating the executor manually if this fails). |
+| `add_env_vars_to_bashrc(env_vars)` | Appends exports to `~/.bashrc` via exec. |
+| `is_pod_running_with_image()` | Lists pods in the namespace; if one is **Running** with `self.image`, returns its **name** (`str`); otherwise `None`. |
+| `get_pod_resource_usage()` | Tries to read `metrics.k8s.io` (often assumes local `kubeconfig`; may not work with remote token only). |
+| `create_resources()` | Creates the pod and waits for `Running` (usually already called from `__init__`). |
+| `handle_sigint(signum, frame)` | Signal handler: cleans up and exits the process. |
+
+**Context manager:** `__enter__` / `__exit__` → leaving `with` calls `stop()` (deletes the pod if cleanup is active).
+
+**Internals (reference):** `_upload_file_to_pod`, `_exec_command_with_exit_code`, `_wait_for_pod_ready` — upload via stdin to exec, command wrapped in `sh -c` with exit-code capture.
+
+---
+
+## Examples
+
+### 1. Remote cluster with token (`.env`: `KUBE_TOKEN`; your app often also sets `REMOTE_CONTROL_PLANE`)
+
+```python
+import os
+from autogen_kubernetes.code_executors.base import CodeBlock
+from autogen_kubernetes.code_executors.kubernetes_commandline_code_executor import (
+    KubernetesCommandLineCodeExecutor,
+)
+
+os.environ.setdefault("KUBE_TOKEN", "...")  # or load_dotenv()
+
+with KubernetesCommandLineCodeExecutor(
+    image="williamgomez712/robin_executor_python:latest",
+    namespace="my-namespace",
+    work_dir="/tmp/robin_executor_test",
+    timeout=120,
+    remote_control_plane="https://API_SERVER:6443",
+    shared_resources=False,
+) as executor:
+    result = executor.execute_code_blocks(
+        [CodeBlock(language="python", code="print('hello')")]
+    )
+    print(result.exit_code, result.output)
+```
+
+### 2. Save file on the pod only (do not execute)
+
+```python
+executor.execution_policies["python"] = False
+result = executor.execute_code_blocks(
+    [CodeBlock(language="python", code="print('does not run')")]
+)
+# result.output will include "Code saved to ..."
+```
+
+### 3. Shell in the pod
+
+```python
+result = executor.execute_code_blocks(
+    [CodeBlock(language="sh", code="echo ok && uname -a")]
+)
+```
+
+### 4. Tooling via uploaded dispatcher (`install_pod_dispatcher`) or `executor.py` baked into the image
+
+```python
+executor.install_pod_dispatcher(default_module="robin_user")
+executor.upload_file_content("robin_user.py", open("robin_user.py").read())
+result = executor.execute_tool_function(
+    {"query": "test"},
+    func_name="my_function",
+    module="robin_user",
+)
+```
+
+If the image already provides `executor.py` under `work_dir`, you can call `execute_tool_function` alone without `install_pod_dispatcher`.
+
+### 5. Local cluster / kubeconfig (no `remote_control_plane`)
+
+```python
+with KubernetesCommandLineCodeExecutor(
+    namespace="default",
+    work_dir="/tmp/work",
+) as executor:
+    ...
+```
+
+(Requires a valid `~/.kube/config` or in-cluster execution.)
+
+---
+
+## `CommandLineCodeResult`
+
+| Field | Meaning |
+|-------|---------|
+| `exit_code` | Exit code of the last relevant command in the sequence. |
+| `output` | Accumulated text (stdout/stderr from exec). |
+| `code_file` | Path of the first generated code file in the pod (if any). |
+
+---
+
+## Practical notes
+
+- **`shared_resources=True`**: reuses a pod with the same `image`; the existing pod’s `work_dir` must match what your code expects, or you may see “file not found” errors.
+- **Filename hints in code**: the first line can set a path with comments like `# filename: foo.py` (and HTML/JS patterns); otherwise a `tmp_code_<md5>.<lang>` under `work_dir` is used.
+- **RBAC**: the token or kubeconfig user needs `pods` + `pods/exec` (and create/delete depending on your flow).
+- After **`stop()`** / exiting **`with`**, the pod is usually **deleted**; do not expect it to remain for debugging unless you skip cleanup or use another workflow.
+
+---
+
+## Publishing to PyPI
+
+- **`[project] name`** is **`kubernetes-robin-executor`**. **`readme`** points at **this file**, so PyPI’s long description matches this document.
+
+- **Manifest:** `autogen-kubernetes/python/packages/autogen-kubernetes/pyproject.toml` (relative to the `autogen-kubernetes` clone).
+
+- **Consumers** (same as local install from PyPI):
+
+```bash
+pip install kubernetes-robin-executor
+```
+
+- **Step-by-step** build/upload (tokens, TestPyPI, `twine`) is in **`tests/PYPI-publish.local.md`** next to the test suite. That file may be **gitignored** in your outer repo; **`tests/README.md`** mentions it.