ms-enclave 0.0.1__tar.gz

ms_enclave-0.0.1/LICENSE

@@ -0,0 +1,201 @@
+                                 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.

ms_enclave-0.0.1/MANIFEST.in

@@ -0,0 +1,7 @@
+include README.md
+
+# Include all resources (code + other files) inside the package
+recursive-include ms_enclave *
+
+# Exclude cache/compiled artifacts
+global-exclude *.py[cod] __pycache__ *.so *.dylib

ms_enclave-0.0.1/PKG-INFO

@@ -0,0 +1,314 @@
+Metadata-Version: 2.4
+Name: ms-enclave
+Version: 0.0.1
+Summary: Modularized and Stable Sandbox runtime environment.
+Author: ModelScope team
+Author-email: contact@modelscope.cn
+License: Apache License 2.0
+Project-URL: Homepage, https://github.com/modelscope/ms-enclave
+Keywords: python,llm,sandbox
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastapi>=0.104.0
+Requires-Dist: uvicorn[standard]>=0.24.0
+Requires-Dist: openai
+Requires-Dist: pydantic>=2.11.7
+Requires-Dist: requests>=2.32.4
+Requires-Dist: shortuuid>=1.0.13
+Requires-Dist: aiohttp>=3.8.1
+Requires-Dist: docstring-parser
+Provides-Extra: dev
+Requires-Dist: pytest>=8.3.5; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23.0; extra == "dev"
+Requires-Dist: pre-commit>=4.2.0; extra == "dev"
+Requires-Dist: jupyter-book>=1.0.4.post1; extra == "dev"
+Requires-Dist: pytest-cov>=6.2.1; extra == "dev"
+Provides-Extra: docker
+Requires-Dist: docker>=7.1.0; extra == "docker"
+Requires-Dist: websocket-client; extra == "docker"
+Dynamic: license-file
+
+# ms-enclave
+
+A modular and stable sandbox runtime environment
+
+## Overview
+
+ms-enclave is a modular and stable sandbox runtime environment that provides a secure isolated execution environment for applications. It achieves strong isolation through Docker containers, with accompanying local/HTTP managers and an extensible tool system, enabling you to safely and efficiently execute code in a controlled environment.
+
+- 🔒 Secure Isolation: Full isolation and resource limitation based on Docker
+- 🧩 Modular: Extensible sandbox and tools (registration factory)
+- ⚡ Stable Performance: Simple implementation, fast startup, lifecycle management
+- 🌐 Remote Management: Built-in FastAPI service, supports HTTP management
+- 🔧 Tool System: Standardized tools enabled by sandbox type (OpenAI-style schema)
+
+## System Requirements
+
+- Python >= 3.10
+- Operating System: Linux, macOS, or Windows with Docker support
+- Docker daemon running locally (Notebook sandbox requires port 8888 open)
+
+## Installation
+
+### Install from PyPI
+
+```bash
+pip install ms-enclave
+```
+
+### Install from Source
+
+```bash
+git clone https://github.com/modelscope/ms-enclave.git
+cd ms-enclave
+pip install -e .
+```
+
+## Quick Start: Minimal Example (SandboxFactory)
+
+> Tools need to be explicitly enabled in the tools_config setting, otherwise they won't be registered.
+
+```python
+import asyncio
+from ms_enclave.sandbox.boxes import SandboxFactory
+from ms_enclave.sandbox.model import DockerSandboxConfig, SandboxType
+
+async def main():
+    config = DockerSandboxConfig(
+        image='python:3.11-slim',
+        memory_limit='512m',
+        tools_config={
+            'python_executor': {},
+            'file_operation': {},
+            'shell_executor': {}
+        }
+    )
+
+    async with SandboxFactory.create_sandbox(SandboxType.DOCKER, config) as sandbox:
+        # 1) Write a file
+        await sandbox.execute_tool('file_operation', {
+            'operation': 'write', 'file_path': '/sandbox/hello.txt', 'content': 'hi from enclave'
+        })
+        # 2) Execute Python code
+        result = await sandbox.execute_tool('python_executor', {
+            'code': "print('Hello from sandbox!')\nprint(open('/sandbox/hello.txt').read())"
+        })
+        print(result.output)
+
+asyncio.run(main())
+```
+
+---
+
+## Typical Usage Scenarios and Examples
+
+- Directly using SandboxFactory: Create/destroy sandboxes in a single process—lightweight; suitable for scripts or one-off tasks
+- Using LocalSandboxManager: Manage the lifecycle/cleanup of multiple sandboxes locally; suitable for service-oriented or multi-task parallel scenarios
+- Using HttpSandboxManager: Unified sandbox management through remote HTTP services; suitable for cross-machine/distributed or more isolated deployments
+
+### 1) Direct Sandbox Creation: SandboxFactory (Lightweight, Temporary)
+
+Usage Scenarios:
+
+- Temporarily execute code in scripts or microservices
+- Fine-grained control over sandbox lifecycle (cleanup upon context exit)
+
+Example (Docker Sandbox + Python Execution):
+
+```python
+import asyncio
+from ms_enclave.sandbox.boxes import SandboxFactory
+from ms_enclave.sandbox.model import DockerSandboxConfig, SandboxType
+
+async def main():
+    cfg = DockerSandboxConfig(
+        tools_config={'python_executor': {}}
+    )
+    async with SandboxFactory.create_sandbox(SandboxType.DOCKER, cfg) as sb:
+        r = await sb.execute_tool('python_executor', {
+            'code': 'import platform; print(platform.python_version())'
+        })
+        print(r.output)
+
+asyncio.run(main())
+```
+
+### 2) Local Unified Management: LocalSandboxManager (Multi-Sandbox, Lifecycle Management)
+
+Usage Scenarios:
+
+- Create/manage multiple sandboxes within the same process (creation, query, stop, periodic cleanup)
+- Unified view for monitoring stats and health
+
+Example:
+
+```python
+import asyncio
+from ms_enclave.sandbox.manager import LocalSandboxManager
+from ms_enclave.sandbox.model import DockerSandboxConfig, SandboxType
+
+async def main():
+    async with LocalSandboxManager() as manager:
+        cfg = DockerSandboxConfig(tools_config={'shell_executor': {}})
+        sandbox_id = await manager.create_sandbox(SandboxType.DOCKER, cfg)
+
+        # Execute command
+        res = await manager.execute_tool(sandbox_id, 'shell_executor', {'command': 'echo hello'})
+        print(res.output.strip())  # hello
+
+        # View list
+        infos = await manager.list_sandboxes()
+        print([i.id for i in infos])
+
+        # Stop and delete
+        await manager.stop_sandbox(sandbox_id)
+        await manager.delete_sandbox(sandbox_id)
+
+asyncio.run(main())
+```
+
+### 3) Remote Unified Management: HttpSandboxManager (Cross-Machine/Isolated Deployment)
+
+Usage Scenarios:
+
+- Run sandbox services on dedicated hosts/containers, invoke remotely via HTTP
+- Share a secure controlled sandbox cluster among multiple applications
+
+Start the service (choose one):
+
+```bash
+# Option A: Command line
+ms-enclave server --host 0.0.0.0 --port 8000
+
+# Option B: Python script
+python -c "from ms_enclave.sandbox import create_server; create_server().run(host='0.0.0.0', port=8000)"
+```
+
+Client Example:
+
+```python
+import asyncio
+from ms_enclave.sandbox.manager import HttpSandboxManager
+from ms_enclave.sandbox.model import DockerSandboxConfig, SandboxType
+
+async def main():
+    async with HttpSandboxManager(base_url='http://127.0.0.1:8000') as m:
+        cfg = DockerSandboxConfig(tools_config={'python_executor': {}})
+        sid = await m.create_sandbox(SandboxType.DOCKER, cfg)
+        r = await m.execute_tool(sid, 'python_executor', {'code': 'print("Hello remote")'})
+        print(r.output)
+        await m.delete_sandbox(sid)
+
+asyncio.run(main())
+```
+
+---
+
+## Sandbox Types and Tool Support
+
+Currently Supported Sandbox Types:
+
+- DOCKER (General-purpose container execution)
+  - Supported tools:
+    - python_executor (execute Python code)
+    - shell_executor (execute Shell commands)
+    - file_operation (read/write/delete/list files)
+  - Features: Configurable memory/CPU limits, volume mounts, network toggling, privileged mode, port mapping
+
+- DOCKER_NOTEBOOK (Jupyter Kernel Gateway environment)
+  - Supported tools:
+    - notebook_executor (execute code via Jupyter Kernel, supports context saving)
+  - Note: This type only loads notebook_executor; other DOCKER-specific tools won't be enabled in this sandbox.
+  - Dependencies: Requires port 8888 exposed and network enabled
+
+Tool Loading Rules:
+
+- Tools are initialized and made available only when explicitly declared in `tools_config`.
+- Tools validate `required_sandbox_type`; unmatched types will be ignored automatically.
+
+Example:
+
+```python
+DockerSandboxConfig(tools_config={'python_executor': {}, 'shell_executor': {}, 'file_operation': {}})
+DockerNotebookConfig(tools_config={'notebook_executor': {}})
+```
+
+---
+
+## Common Configuration Options
+
+- `image`: Docker image name (e.g., `python:3.11-slim` or `jupyter-kernel-gateway`)
+- `memory_limit`: Memory limit (e.g., `512m` / `1g`)
+- `cpu_limit`: CPU limit (float > 0)
+- `volumes`: Volume mounts, e.g., `{host_path: {"bind": "/container/path", "mode": "rw"}}`
+- `ports`: Port mappings, e.g., `{ "8888/tcp": ("127.0.0.1", 8888) }`
+- `network_enabled`: Enable network (Notebook sandbox requires True)
+- `remove_on_exit`: Automatically remove container on exit (default True)
+
+---
+
+## Error Handling and Debugging
+
+```python
+result = await sandbox.execute_tool('python_executor', {'code': 'print(1/0)'})
+if result.error:
+    print('Error:', result.error)
+else:
+    print('Output:', result.output)
+```
+
+---
+
+## Development and Testing
+
+```bash
+# Clone the repository
+git clone https://github.com/modelscope/ms-enclave.git
+cd ms-enclave
+
+# Setup virtual environment
+python -m venv venv
+source venv/bin/activate  # Windows: venv\Scripts\activate
+
+# Install dependencies
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Run examples (provided in the repository)
+python examples/sandbox_usage_examples.py
+python examples/local_manager_example.py
+python examples/server_manager_example.py
+```
+
+---
+
+## Available Tools
+
+- `python_executor`: Execute Python code (DOCKER)
+- `shell_executor`: Execute Shell commands (DOCKER)
+- `file_operation`: Read/Write/Delete/List files (DOCKER)
+- `notebook_executor`: Execute via Jupyter Kernel (DOCKER_NOTEBOOK)
+- You can also register custom tools via the Tool factory (`@register_tool`).
+
+---
+
+## Contribution
+
+We welcome contributions! Please check [CONTRIBUTING.md](CONTRIBUTING.md) for details.
+
+### Steps to Contribute
+
+1. Fork the repository
+2. Create a feature branch: `git checkout -b feature/amazing-feature`
+3. Develop and add tests
+4. Run local tests: `pytest`
+5. Commit changes: `git commit -m 'Add amazing feature'`
+6. Push the branch: `git push origin feature/amazing-feature`
+7. Submit a Pull Request
+
+## License
+
+This project is licensed under the Apache 2.0 License. See [LICENSE](LICENSE) for details.