mem-sandbox 0.1.0__tar.gz

mem_sandbox-0.1.0/.gitignore

@@ -0,0 +1,219 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# 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/
+benchmark-results/
+
+# 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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.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
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.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/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

mem_sandbox-0.1.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,31 @@
+# Code of Conduct
+
+MemSandbox contributors are expected to maintain a welcoming, respectful, and
+professional environment.
+
+## Expected behavior
+
+- Discuss ideas and code constructively.
+- Respect different experience levels, backgrounds, and viewpoints.
+- Give actionable feedback focused on the work.
+- Accept correction gracefully and help repair misunderstandings.
+- Protect private information shared during security or conduct reports.
+
+## Unacceptable behavior
+
+- Harassment, discrimination, threats, or personal attacks.
+- Sexualized language or unwanted attention.
+- Deliberate intimidation, stalking, or disclosure of private information.
+- Sustained disruption of project discussions or review processes.
+- Retaliation against someone who raises a concern in good faith.
+
+## Enforcement
+
+Project maintainers may edit or remove contributions, comments, or other participation
+that violates these expectations. Repeated or severe violations may result in a temporary
+or permanent ban from project spaces.
+
+Report conduct concerns privately to a project maintainer using a private contact method
+listed on the maintainer's GitHub profile. Do not open a public issue containing sensitive
+or identifying information. Maintainers will review reports confidentially, avoid
+conflicts of interest, and respond proportionately.

mem_sandbox-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,89 @@
+# Contributing to MemSandbox
+
+Thank you for helping build MemSandbox.
+
+## Before starting
+
+1. Open or select a GitHub issue describing the behavior and acceptance criteria.
+2. Keep the main checkout on `main`.
+3. Create a short-lived issue branch in a separate worktree:
+
+   ```console
+   git fetch origin
+   git worktree add ../mem-sandbox-<short-name> -b feature/<issue>-<short-name> main
+   ```
+
+Use `fix/<issue>-<short-name>` for bug fixes. Do not implement directly in the main
+checkout.
+
+## Development setup
+
+Install Python 3.12 or later and [uv](https://docs.astral.sh/uv/), then run:
+
+```console
+uv sync --all-groups
+```
+
+## Implementation expectations
+
+- Write or update behavior tests before implementation.
+- Keep core modules independent of agent frameworks.
+- Express collaborators through narrow constructor-injected interfaces.
+- Use immutable domain request and result types at boundaries.
+- Reject unsupported behavior explicitly; never fall back to the host filesystem or shell.
+- Update the owning module `README.md` when behavior, interfaces, invariants, or
+  dependencies change.
+
+## Required checks
+
+Run the same checks used by CI:
+
+```console
+uv run pytest
+uv run ruff format --check src tests
+uv run ruff check src tests
+uv run pyright src tests
+uv build
+```
+
+## Pull requests
+
+Keep each pull request focused on one issue or behavior seam. Explain the behavior change,
+important design decisions, and any deferred work. Link the issue and ensure all required
+checks pass before merge.
+
+## Publishing a release
+
+Publishing is maintainer-only and uses
+[PyPI Trusted Publishing](https://docs.pypi.org/trusted-publishers/) rather than a
+long-lived repository token. The PyPI publisher must match:
+
+| Setting | Value |
+|---|---|
+| Project | `mem-sandbox` |
+| Repository owner | `hahahahahaiyiwen` |
+| Repository | `mem-sandbox` |
+| Workflow | `publish.yml` |
+| GitHub environment | `pypi` |
+
+The protected `pypi` environment should require approval. Its publish job receives only
+`contents: read` and `id-token: write`; the separate build job cannot request an OIDC
+token.
+
+To publish:
+
+1. Merge the release changes and a unique semantic version in `pyproject.toml` to
+   `main`.
+2. Confirm the required `main` checks pass.
+3. Create and push an annotated `v<version>` tag at the intended `main` commit.
+4. Publish a GitHub release for that tag.
+5. Approve the `pypi` environment deployment after reviewing the workflow's built
+   distributions.
+6. Install the exact version from PyPI in a clean environment and verify its public
+   imports.
+
+The release workflow rejects a tag that does not exactly match
+`v<project.version>`, builds the wheel and source distribution once, validates their
+metadata, and publishes those same artifacts. PyPI versions and uploaded files are
+immutable; correct a failed release with a new version rather than attempting to replace
+an existing one.

mem_sandbox-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 MemSandbox contributors
+
+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.

mem_sandbox-0.1.0/PKG-INFO

@@ -0,0 +1,228 @@
+Metadata-Version: 2.5
+Name: mem-sandbox
+Version: 0.1.0
+Summary: A deterministic in-memory workspace and command sandbox for AI agents
+Project-URL: Documentation, https://github.com/hahahahahaiyiwen/mem-sandbox/tree/main/docs
+Project-URL: Issues, https://github.com/hahahahahaiyiwen/mem-sandbox/issues
+Project-URL: Repository, https://github.com/hahahahahaiyiwen/mem-sandbox
+License-Expression: MIT
+License-File: LICENSE
+Keywords: agents,ai,filesystem,sandbox,workspace
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Provides-Extra: openai-agents
+Requires-Dist: openai-agents<0.23,>=0.22; extra == 'openai-agents'
+Description-Content-Type: text/markdown
+
+# MemSandbox
+
+A deterministic in-memory workspace and constrained command environment for AI agents.
+
+MemSandbox lets an application give an agent stateful files, familiar POSIX-shaped
+commands, snapshots, policy enforcement, and explicit lifecycle management without
+giving the model direct access to the host filesystem or shell.
+
+> **Status:** The framework-neutral core and first native OpenAI Agents SDK
+> integration are implemented and tested on Python 3.12 and 3.14 for Linux and Windows.
+> APIs may still change before the first stable release.
+
+## Quick start
+
+Prerequisites:
+
+- Python 3.12 or later (3.12 and 3.14 are tested in CI)
+- [uv](https://docs.astral.sh/uv/)
+
+Clone the repository and install its optional integration dependencies:
+
+```console
+git clone https://github.com/hahahahahaiyiwen/mem-sandbox.git
+cd mem-sandbox
+uv sync --all-groups
+```
+
+### 1. Explore MemSandbox without a model
+
+```console
+uv run python -m samples.shared
+```
+
+This opens an empty, process-local sandbox with no credentials, model, or network
+request:
+
+```text
+mem-sandbox:/workspace> pwd
+/workspace
+mem-sandbox:/workspace> mkdir demo
+mem-sandbox:/workspace> echo hello > demo/message.txt
+mem-sandbox:/workspace> cat demo/message.txt
+hello
+mem-sandbox:/workspace> exit
+```
+
+Commands run in MemSandbox's constrained virtual command language, not a host shell.
+The in-memory session is deleted when the CLI exits.
+
+### 2. Run the `workspace-edit` agent scenario
+
+Choose one inference provider.
+
+**Official OpenAI**
+
+```sh
+export OPENAI_API_KEY="<api-key>"
+export OPENAI_MODEL="<model>"
+
+uv run python -m samples.openai_agents_sdk.providers.openai \
+  --scenario workspace-edit \
+  --inspect
+```
+
+**Azure OpenAI**
+
+```sh
+export AZURE_OPENAI_ENDPOINT="https://<resource>.openai.azure.com"
+export AZURE_OPENAI_API_KEY="<api-key>"
+export AZURE_OPENAI_API_VERSION="<api-version>"
+export AZURE_OPENAI_DEPLOYMENT="<deployment-name>"
+
+uv run python -m samples.openai_agents_sdk.providers.azure_openai \
+  --scenario workspace-edit \
+  --inspect
+```
+
+The scenario asks the agent to create a file, read its content hash, apply a guarded
+patch from `status=pending` to `status=complete`, and read the result. Host code verifies
+the exact final bytes before `--inspect` attaches the constrained CLI to the same live
+session:
+
+```text
+mem-sandbox:/workspace> cat /workspace/demo/report.txt
+status=complete
+mem-sandbox:/workspace> exit
+```
+
+Live runs are billable and require network access. Credentials are read from the process
+environment and are never placed in the sandbox. For provider requirements, see the
+[official OpenAI guide](./samples/openai_agents_sdk/providers/openai/README.md) or
+[Azure OpenAI guide](./samples/openai_agents_sdk/providers/azure_openai/README.md).
+To embed the integration in an application instead of running the repository scenario,
+follow the complete
+[`SandboxAgent` usage path](./src/mem_sandbox/integrations/openai_agents/README.md#use-with-sandboxagent).
+
+List the other available scenarios without credentials or a network request:
+
+```console
+uv run python -m samples.openai_agents_sdk.providers.openai --list-scenarios
+```
+
+## How the agent integration works
+
+```text
+Official OpenAI or Azure OpenAI
+    |
+    v
+OpenAI Agents SDK SandboxAgent
+    |
+    v
+InMemorySandboxCapability
+    |
+    v
+MemSandbox session
+    +-- in-memory POSIX workspace
+    +-- constrained command executor
+    +-- policy, quotas, events, and snapshots
+    |
+    +-- host verification and optional inspection CLI
+```
+
+The model receives exactly four tools: `execute`, `read_file`, `write_file`, and
+`apply_patch`. It does not receive a sandbox handle, lifecycle controls, snapshot
+authority, secrets, mounts, ports, network access, a host shell, or arbitrary process
+execution.
+
+Choose the documentation path that matches the task:
+
+- **Run a maintained live example:** use the
+  [OpenAI Agents SDK samples](./samples/openai_agents_sdk/README.md).
+- **Embed the public interfaces:** use the
+  [reader-first OpenAI integration guide](./src/mem_sandbox/integrations/openai_agents/README.md#use-with-sandboxagent).
+- **Review adapter invariants:** use the integration guide's
+  [engineering reference](./src/mem_sandbox/integrations/openai_agents/README.md#engineering-reference).
+
+## What MemSandbox provides
+
+- **Stateful virtual workspace:** byte-oriented files and directories with canonical
+  POSIX paths, atomic mutations, content hashes, and configurable quotas.
+- **Constrained command environment:** deterministic implementations of selected
+  familiar commands, including pipelines, conditionals, environment changes, and
+  redirection.
+- **Lifecycle service:** create, look up, resume, and delete isolated process-local
+  sessions through opaque host-owned handles.
+- **Portable state:** bounded workspace archives, snapshots, resume, and isolated forks.
+- **Host-owned controls:** policy, secrets, events, limits, manifests, and capability
+  selection remain application responsibilities.
+- **Framework-neutral core:** agent SDK packages are optional adapters over the same
+  domain API.
+
+The implemented command profile includes `pwd`, `cd`, `ls`, `cat`, `echo`, `mkdir`,
+`touch`, `rm`, `head`, `tail`, `grep`, `find`, `wc`, `sort`, `uniq`, `cp`, `mv`, `env`,
+`export`, and `unset`. This is an explicit virtual command language, not a complete shell.
+
+## Security boundary
+
+MemSandbox is a **logical and API sandbox**, not an operating-system isolation boundary.
+Supported operations do not fall through to the host filesystem or shell, but arbitrary
+Python or native code running in the same process is outside its containment model.
+
+Use a process, container, VM, microVM, or WASM boundary when executing untrusted
+arbitrary code. Network access, host subprocesses, mounts, PTYs, and full POSIX shell
+compatibility are not part of the current profile.
+
+Read the [high-level design](./docs/HIGH_LEVEL_DESIGN.md) and
+[OpenAI integration boundary](./src/mem_sandbox/integrations/openai_agents/README.md)
+before embedding MemSandbox in a security-sensitive application.
+
+## Project status and documentation
+
+Milestone 5 delivered the first native integration through
+`openai-agents>=0.22,<0.23`, tested exactly with `0.22.0`. Other framework and transport
+integrations remain non-gating follow-ups.
+
+- [Design and research index](./docs/README.md)
+- [High-level design](./docs/HIGH_LEVEL_DESIGN.md)
+- [Implementation plan](./docs/PLAN.md)
+- [Run samples and configure providers](./samples/README.md)
+- [Embed or maintain the OpenAI Agents SDK integration](./src/mem_sandbox/integrations/openai_agents/README.md)
+- [Workspace design](./docs/components/workspace/README.md)
+- [Command executor design](./docs/components/command-executor/README.md)
+- [Product validation and benchmarks](./docs/product-validation/README.md)
+
+## Development
+
+```console
+uv sync --all-groups
+uv run pytest
+uv run ruff format --check benchmarks evaluations samples src tests
+uv run ruff check benchmarks evaluations samples src tests
+uv run pyright benchmarks evaluations samples src tests
+uv build
+```
+
+Development uses short-lived issue branches in separate Git worktrees. The main checkout
+stays on `main`, and changes reach it through pull requests.
+
+## Contributing, security, and license
+
+See [CONTRIBUTING.md](./CONTRIBUTING.md) before starting a change. Report security issues
+using the private process in [SECURITY.md](./SECURITY.md), not a public issue.
+
+MemSandbox is licensed under the [MIT License](./LICENSE).