ipybox 0.2.0__tar.gz

ipybox-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.

ipybox-0.2.0/PKG-INFO

@@ -0,0 +1,291 @@
+Metadata-Version: 2.1
+Name: ipybox
+Version: 0.2.0
+Summary: Python code execution sandbox based on IPython and Docker
+Home-page: https://github.com/gradion-ai/ipybox
+License: Apache-2.0
+Author: Martin Krasser
+Author-email: martin@gradion.ai
+Requires-Python: >=3.10,<3.13
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: aiodocker (>=0.23.0,<0.24.0)
+Requires-Dist: aiofiles (>=24.1,<25.0)
+Requires-Dist: aiohttp (>=3.10,<4.0)
+Requires-Dist: pillow (>=11.0,<12.0)
+Requires-Dist: tornado (>=6.4,<7.0)
+Requires-Dist: typer (>=0.12.5,<0.13.0)
+Description-Content-Type: text/markdown
+
+# ipybox
+
+A secure, lightweight Python code execution sandbox based on IPython and Docker, specifically designed for AI/ML applications and LLM agents.
+
+<p align="center">
+  <img src="docs/logo.png" alt="logo">
+</p>
+
+## Overview
+
+This project provides a sandboxed Python code execution environment built on IPython and Docker. It offers:
+
+- **Secure Execution**: Code runs in Docker containers, preventing unauthorized system access
+- **Flexible Dependencies**: Supports static and runtime dependency management
+- **Real-time Streaming**: Chunked streaming of execution output as it's generated
+- **Image Support**: Handle image outputs from matplotlib and other visualization libraries
+- **Resource Control**: Container lifecycle management and built-in timeout mechanisms
+- **Reproducible Environment**: Consistent execution environment across different systems
+- **LLM Agent Ready**: Ideal for AI applications that need to execute Python code
+
+This project is in early beta, with active development of new features ongoing.
+
+## Installation
+
+### Python package
+
+```bash
+pip install ipybox
+```
+
+### Container image
+
+**Note**: Building the container image requires [Docker](https://www.docker.com/) to be installed. Containers will run with the same user and group IDs as the user who built the image, ensuring proper file permissions on mounted host directories.
+
+#### Default build
+
+To build a container image with default settings and no extra dependencies:
+
+```bash
+python -m ipybox build
+```
+
+This creates a Docker image tagged as `gradion/ipybox` with base Python dependencies required for the code execution environment.
+
+#### Custom build
+
+To create a custom image with additional dependencies for your application, create a dependencies file (e.g., `dependencies.txt`) following. For example:
+
+```txt
+pandas = "^2.2"
+scikit-learn = "^1.5"
+matplotlib = "^3.9"
+```
+
+To build the image with custom tag and dependencies:
+
+```bash
+python -m ipybox build \
+    --tag my-box:v1 \
+    --dependencies path/to/dependencies.txt
+```
+
+The dependencies file should list Python packages in [Poetry dependency specification format](https://python-poetry.org/docs/dependency-specification/). These will be installed in addition to the base dependencies required for the execution environment. The execution container also supports [installing dependencies at runtime](#installing-dependencies-at-runtime).
+
+## Usage
+
+The following examples demonstrate how to use the `ExecutionContainer` and `ExecutionClient` context managers to execute Python code in an IPython environment running in a Docker container. Runnable scripts of the following code snippets are available in the [examples](examples/) directory.
+
+### Basic usage
+
+Here's a simple example that demonstrates how to execute Python code in an execution container. The `ExecutionContainer` context manager creates and starts a container for code execution, and the `ExecutionClient` context manager connects to an IPython kernel running in the container. The example below executes the code `print('Hello, world!')` and prints the output text:
+
+```python
+from gradion.executor import ExecutionContainer, ExecutionClient
+
+# Create and start a container for code execution
+async with ExecutionContainer(tag="gradion/executor") as container:
+    # Create and connect to an IPython kernel
+    async with ExecutionClient(host="localhost", port=container.port) as client:
+        # Execute Python code and await the result
+        result = await client.execute("print('Hello, world!')")
+        # Print the execution output text
+        print(f"Output: {result.text}")  # Output: Hello, world!
+```
+
+The default image used by `ExecutionContainer` is `gradion/executor`. You can specify a custom image with the `tag` argument like in `ExecutionContainer(tag="my-box:v1")`, for example.
+
+### State management
+
+Code execution within the same client context is stateful i.e. you can reference variables from previous executions. Code executions in different client contexts are isolated from each other:
+
+```python
+async with ExecutionContainer() as container:
+    async with ExecutionClient(host="localhost", port=container.port) as client_1:
+        # Execute code that defines variable x
+        result = await client_1.execute("x = 1")
+        assert result.text is None
+
+        # Reference variable x defined in previous execution
+        result = await client_1.execute("print(x)")
+        assert result.text == "1"
+
+    async with ExecutionClient(host="localhost", port=container.port) as client_2:
+        # Variable x is not defined in this client context
+        try:
+            await client_2.execute("print(x)")
+        except ExecutionError as e:
+            assert e.args[0] == "NameError: name 'x' is not defined"
+```
+
+### Output streaming
+
+The execution client supports streaming output as it's generated during code execution:
+
+```python
+async with ExecutionContainer() as container:
+    async with ExecutionClient(host="localhost", port=container.port) as client:
+        # Code that produces output gradually
+        code = """
+        import time
+        for i in range(5):
+            print(f"Processing step {i}")
+            time.sleep(1)
+        """
+
+        # Submit the execution and stream the output
+        execution = await client.submit(code)
+        async for chunk in execution.stream():
+            # Output will be printed gradually:
+            print(f"Received output: {chunk}")
+            # Received output: Processing step 0
+            # Received output: Processing step 1
+            # Received output: Processing step 2
+            # Received output: Processing step 3
+            # Received output: Processing step 4
+
+        # Get the aggregated result
+        result = await execution.result()
+        # Print the aggregated output text
+        print(f"Aggregated output:\n{result.text}")
+        # Aggregated output:
+        # Processing step 0
+        # Processing step 1
+        # Processing step 2
+        # Processing step 3
+        # Processing step 4
+```
+
+The `stream()` method accepts an optional `timeout` argument (defaults to 120 seconds). In case of timeout, the execution is automatically terminated by interrupting the kernel.
+
+### Installing dependencies at runtime
+
+```python
+async with ExecutionContainer() as container:
+    async with ExecutionClient(host="localhost", port=container.port) as client:
+        # Install the einops package
+        await client.execute("!pip install einops")
+        # Then you can use it in the following code
+        # execution within the same client context
+        result = await client.execute("""
+            import einops
+            print(einops.__version__)
+        """)
+        print(f"Output: {result.text}")  # Output: 0.8.0
+```
+
+### Creating and returning plots
+
+Plots created with `matplotlib` or other libraries are returned as PIL images:
+
+```python
+async with ExecutionContainer() as container:
+    async with ExecutionClient(host="localhost", port=container.port) as client:
+        execution = await client.submit("""
+            !pip install matplotlib
+
+            import matplotlib.pyplot as plt
+            import numpy as np
+            import time
+
+            x = np.linspace(0, 10, 100)
+            plt.figure(figsize=(8, 6))
+            plt.plot(x, np.sin(x))
+            plt.title('Sine Wave')
+            plt.show()
+
+            print("Plot generation complete!")
+            """)
+
+        # Stream the output text as it's generated
+        async for chunk in execution.stream():
+            print(chunk, end="", flush=True)
+
+        # Obtain the execution result
+        result = await execution.result()
+        assert "Plot generation complete!" in result.text
+
+        # Get created PIL image from the result
+        result.images[0].save(f"output.png")
+```
+
+Images are not part of the output stream, but are available as a `images` list in the `result` object. The example above saves the created image as [output.png](docs/sine.png):
+
+### Bind mounts
+
+You can mount host directories into the container to allow code execution to access external files:
+
+```python
+# Map host paths to container paths. Host paths can be absolute or relative.
+# Container paths must be relative and are created as subdirectories of the
+# /app directory in the container. The /app directory is the container's
+# working directory.
+binds = {
+    "./data": "data",  # Read data from host
+    "./output": "output"  # Write results to host
+}
+
+# Create a data file on the host
+async with aiofiles.open("data/input.txt", "w") as f:
+    await f.write("hello world")
+
+async with ExecutionContainer(binds=binds) as container:
+    async with ExecutionClient(host="localhost", port=container.port) as client:
+        # Read from mounted data directory
+        result = await client.execute("""
+            with open('data/input.txt') as f:
+                data = f.read()
+
+            # Process data...
+            processed = data.upper()
+
+            # Write to mounted output directory
+            with open('output/result.txt', 'w') as f:
+                f.write(processed)
+        """)
+
+# Check the result file on the host
+async with aiofiles.open("output/result.txt", "r") as f:
+    assert await f.read() == "HELLO WORLD"
+```
+
+### Environment variables
+
+Environment variables can be passed to the container for configuration or secrets:
+
+```python
+env = {
+    "API_KEY": "secret-key-123",
+    "DEBUG": "1"
+}
+
+async with ExecutionContainer(env=env) as container:
+    async with ExecutionClient(host="localhost", port=container.port) as client:
+        # Access environment variables in executed code
+        result = await client.execute("""
+            import os
+
+            api_key = os.environ['API_KEY']
+            print(f"Using API key: {api_key}")
+
+            debug = bool(int(os.environ.get('DEBUG', '0')))
+            if debug:
+                print("Debug mode enabled")
+        """)
+        print(result.text)
+        # Using API key: secret-key-123
+        # Debug mode enabled
+```
+