vsh-python 0.3.1__cp313-cp313-win_amd64.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
vsh/mcp/surface.py ADDED
@@ -0,0 +1,17 @@
1
+ from __future__ import annotations as _annotations
2
+
3
+ from fastmcp import FastMCP
4
+
5
+ from .native_tools import vsh_run
6
+
7
+ __all__ = ("register_vsh_agent_surface", "register_vsh_surface")
8
+
9
+
10
+ def register_vsh_surface(mcp: FastMCP) -> None:
11
+ """Register the single native VSH transaction tool."""
12
+ mcp.add_tool(vsh_run)
13
+
14
+
15
+ def register_vsh_agent_surface(mcp: FastMCP) -> None:
16
+ """Register the same single-tool surface for agent runs."""
17
+ mcp.add_tool(vsh_run)
vsh/py.typed ADDED
@@ -0,0 +1 @@
1
+
@@ -0,0 +1,199 @@
1
+ Metadata-Version: 2.4
2
+ Name: vsh-python
3
+ Version: 0.3.1
4
+ Classifier: Development Status :: 4 - Beta
5
+ Classifier: Intended Audience :: Developers
6
+ Classifier: Programming Language :: Python :: 3
7
+ Classifier: Programming Language :: Python :: 3.11
8
+ Classifier: Programming Language :: Python :: 3.12
9
+ Classifier: Programming Language :: Python :: 3.13
10
+ Classifier: Programming Language :: Python :: 3.14
11
+ Classifier: Programming Language :: Rust
12
+ Requires-Dist: basedpyright ; extra == 'dev'
13
+ Requires-Dist: maturin==1.15.0 ; extra == 'dev'
14
+ Requires-Dist: pytest ; extra == 'dev'
15
+ Requires-Dist: pytest-cov ; extra == 'dev'
16
+ Requires-Dist: ruff ; extra == 'dev'
17
+ Requires-Dist: setuptools==84.0.0 ; extra == 'dev'
18
+ Requires-Dist: ty ; extra == 'dev'
19
+ Requires-Dist: zensical==0.0.57 ; extra == 'dev'
20
+ Requires-Dist: fastmcp==3.4.7 ; extra == 'mcp'
21
+ Provides-Extra: dev
22
+ Provides-Extra: mcp
23
+ License-File: LICENSE
24
+ Summary: VSH is a low-latency transactional filesystem simulator backed by Rust.
25
+ Keywords: agents,commands,mcp,simulation,workspaces
26
+ Home-Page: https://github.com/fswair/vsh
27
+ License: Apache-2.0
28
+ Requires-Python: >=3.11
29
+ Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
30
+
31
+ # VSH
32
+
33
+ VSH is one low-latency transactional filesystem simulator with two SDK surfaces:
34
+
35
+ - native Rust through the `vsh` crate, backed by `vsh-runtime`,
36
+ - Python through the `vsh-python` PyPI distribution and `vsh` import package.
37
+
38
+ Both surfaces execute the same Rust pipeline. Python is a thin PyO3 binding; it does
39
+ not contain a fallback simulator or committer.
40
+
41
+ ```text
42
+ Monty program → immutable snapshot → Rust VirtualFs → canonical diff → policy
43
+ → dependency revalidation → recoverable commit → verified receipt
44
+ ```
45
+
46
+ VSH is not a POSIX shell and never gives Monty a host filesystem mount, subprocess,
47
+ network, or ambient environment capability.
48
+
49
+ ## Python
50
+
51
+ Install the wheel:
52
+
53
+ ```bash
54
+ uv add vsh-python
55
+ ```
56
+
57
+ Run one complete transaction. `PREVIEW` guarantees that host files are unchanged;
58
+ `AUTO` commits only a deterministic native auto-approval.
59
+
60
+ ```python
61
+ from vsh import ReceiptDetail, RunMode, RunRequest, Runtime
62
+
63
+ runtime = Runtime.open("/path/to/workspace")
64
+ receipt = runtime.run(
65
+ RunRequest(
66
+ """
67
+ from pathlib import Path
68
+ text = Path('/workspace/input.txt').read_text()
69
+ Path('/workspace/output.txt').write_text(text.upper())
70
+ len(text)
71
+ """,
72
+ mode=RunMode.AUTO,
73
+ detail=ReceiptDetail.FULL,
74
+ )
75
+ )
76
+
77
+ print(receipt.state, receipt.result, receipt.changes)
78
+ ```
79
+
80
+ The GIL is released while snapshotting, executing Monty, generating the diff,
81
+ evaluating policy, revalidating dependencies, and committing.
82
+
83
+ ## Rust
84
+
85
+ ```toml
86
+ [dependencies]
87
+ vsh = "=0.3.1"
88
+ ```
89
+
90
+ ```rust,no_run
91
+ use vsh::{ReceiptDetail, RunMode, RunRequest, Runtime, RuntimeConfig};
92
+
93
+ fn main() -> Result<(), vsh::VshError> {
94
+ let runtime = Runtime::open(RuntimeConfig::new("/path/to/workspace"))?;
95
+ let receipt = runtime.run(
96
+ RunRequest::new(
97
+ "from pathlib import Path\nPath('/workspace/output.txt').write_text('ok')",
98
+ )
99
+ .with_mode(RunMode::Auto)
100
+ .with_detail(ReceiptDetail::Full),
101
+ )?;
102
+ println!("{:?} {}", receipt.state, receipt.transaction);
103
+ Ok(())
104
+ }
105
+ ```
106
+
107
+ Production execution expects the matching `vsh-monty-worker` executable. Python
108
+ wheels bundle it; native embedders configure its trusted path through
109
+ `RuntimeConfig::with_worker_path`.
110
+
111
+ ## MCP
112
+
113
+ Install the optional adapter and start the stdio server:
114
+
115
+ ```bash
116
+ uv add "vsh-python[mcp]"
117
+ vsh serve
118
+ ```
119
+
120
+ The server exposes exactly one normal tool, `vsh_run`. A multi-file operation is one
121
+ Monty program, one Rust transaction, one policy decision, and one Python-to-Rust call.
122
+ An auto-approved preview can later be promoted by passing its returned transaction
123
+ handle with `mode="auto"`; VSH revalidates dependencies before any mutation.
124
+
125
+ Auto-approved previews use a bounded process-local fast path and must be promoted by
126
+ the same live `Runtime` (or MCP server process). The exact artifact is made durable
127
+ before reservation and commit. Transactions that require independent approval are
128
+ durable immediately and survive a runtime restart.
129
+
130
+ ## Security and dependency policy
131
+
132
+ - External Rust crates are exact-pinned in the workspace manifest and lockfile.
133
+ - Unknown, abandoned, yanked, Git-only, wildcard, and unreviewed crates are rejected.
134
+ - `cargo audit` and `cargo deny` are release gates.
135
+ - The hash-locked optional/development Python graph is a strict `pip-audit` gate.
136
+ - Protected paths are denied before names or bytes enter Monty.
137
+ - Approval binds the exact program, snapshot, read/write dependencies, canonical diff,
138
+ policy, execution configuration, and intent.
139
+ - The committer is the only host writer and serializes only same-workspace commit
140
+ revalidation/mutation; independent runtimes do not share a global lock.
141
+ - Process-local preview retention is fail-closed and bounded by both artifact count and
142
+ encoded bytes; it cannot become an unbounded parent-process cache.
143
+
144
+ See [the threat model](docs/rust-rewrite/THREAT_MODEL.md),
145
+ [guarantees](docs/rust-rewrite/GUARANTEES.md), and
146
+ [dependency record](docs/rust-rewrite/DEPENDENCY_POLICY.md). Upgrade and benchmark
147
+ details are in the [migration guide](docs/rust-rewrite/MIGRATION.md) and
148
+ [performance record](docs/rust-rewrite/PERFORMANCE.md). Merge coverage scope and floors
149
+ are recorded in the [coverage contract](docs/rust-rewrite/COVERAGE.md). The cross-platform build,
150
+ validation, provenance, and dual-registry order are in the
151
+ [release guide](docs/rust-rewrite/RELEASE.md).
152
+
153
+ ## Compatibility handles
154
+
155
+ Existing declarations may continue to install `vbash==0.3.1` from PyPI or depend on
156
+ `vbash = "=0.3.1"` from crates.io. Both packages are implementation-free mirrors of
157
+ the exact matching VSH release. New projects should use `vsh-python` and `vsh`
158
+ directly; Python code continues to write `import vsh` either way.
159
+
160
+ ## Documentation
161
+
162
+ The detailed Rust, Python, MCP, agent, architecture, security, and benchmark guides are
163
+ built with the exactly pinned Zensical toolchain:
164
+
165
+ ```bash
166
+ uv run python scripts/generate_llms_txt.py
167
+ uv run zensical serve
168
+ uv run zensical build --clean --strict
169
+ ```
170
+
171
+ Start at [`docs/index.md`](docs/index.md). The site includes a VSH-specific dark-red
172
+ design, automatic light/dark palette selection, and a **Copy as Markdown** action on
173
+ every page. It also publishes a compact LLM index at `/llms.txt` and the complete
174
+ Markdown source corpus at `/llms-full.txt`, with navigation pages first; CI verifies
175
+ both generated files are current.
176
+
177
+ ## Development
178
+
179
+ ```bash
180
+ uv sync --frozen --all-groups --extra mcp
181
+ cargo fmt --all -- --check
182
+ cargo test --workspace --all-targets --locked
183
+ cargo llvm-cov --workspace --all-features --all-targets --locked --summary-only \
184
+ --ignore-filename-regex '(vsh-python|vsh-worker)' \
185
+ --fail-under-lines 79 --fail-under-functions 70 --fail-under-regions 81
186
+ cargo clippy --workspace --all-targets --all-features --locked -- -D warnings
187
+ uv run ruff check
188
+ uv run ruff format --check
189
+ uv run pytest \
190
+ tests/test_native_binding.py tests/test_native_runtime.py tests/test_python_surface.py \
191
+ --cov=src/vsh --cov-branch --cov-report=term-missing --cov-fail-under=100
192
+ cargo run --release --locked -p vsh-runtime --example native_benchmark -- \
193
+ --worker "$PWD/.venv/bin/vsh-monty-worker"
194
+ ```
195
+
196
+ ## License
197
+
198
+ Apache-2.0
199
+
@@ -0,0 +1,21 @@
1
+ THIRD_PARTY_NOTICES.md,sha256=Uqd9OWRq33N_y2VhdIDA9gvHehizHA1skhioCJgHc-s,1458
2
+ vsh/__init__.py,sha256=z3r2d5Hx9Q50LNmQU17BKz-uio-my7UfLTRUp_8rmMU,770
3
+ vsh/__main__.py,sha256=jWgKrhr3e7yDh6V08TSyVsiRwHHsdQOhSK4jmeJIqEI,119
4
+ vsh/_native.cp313-win_amd64.pyd,sha256=RcYzk8245zXlsvWnAo53IzN8mYz2WEtS-9DanklM7jw,7089152
5
+ vsh/_native.pyi,sha256=Y56MI_67ieY8B38_wvq0PFSxtGgg-fij6P2_aT1Ri6o,5933
6
+ vsh/_version.py,sha256=6LmgTW3F51pnIViYhHL5xyXlUcCCaZDP6rrOJzoiBtk,138
7
+ vsh/cli.py,sha256=OC3eVumZ_GumCmQPkJii2e_QGROfGtwSqodRhQcyCI0,2121
8
+ vsh/mcp/__init__.py,sha256=yLc2cl3J86RpPeX57XBZHtiGYryB3KA7MCEvFh59uAE,150
9
+ vsh/mcp/codemode_server.py,sha256=wFMCGAsW3xxhOnhnFF4rbE7s3vJh_LY5FEWkRuqWrS8,4091
10
+ vsh/mcp/native_tools.py,sha256=tmjo4BbfCgjuyme_rkU0h2ucwdM-0wZsdVHCe1PM8No,6332
11
+ vsh/mcp/prompts.py,sha256=Z-ttU0zGn3THoRwqw_NItQ4-mGzPJ9KEw3fFrRq96XE,1379
12
+ vsh/mcp/server.py,sha256=B5EfPNFMGYa1qQcjdIdqOjsMnUEYvynhoyRxA_wJcXM,179
13
+ vsh/mcp/surface.py,sha256=-mS9DbrLtrhoIeqiFsUEVJIkfKQKl0ufPLCcQSAShEs,479
14
+ vsh/py.typed,sha256=frcCV1k9oG9oKj3dpUqdJg1PxRT2RSN_XKdLCPjaYaY,2
15
+ vsh_python-0.3.1.data/scripts/vsh-monty-worker.exe,sha256=8X3WkkrJ1gLhKLSdKvP7CkNn3a-YXEkj6PaY3sm00Nw,6259712
16
+ vsh_python-0.3.1.dist-info/METADATA,sha256=rWwKtS_u_wZMMncPCA9ORpSLPaj_toHsT5qNvtNPGMQ,7515
17
+ vsh_python-0.3.1.dist-info/WHEEL,sha256=s-xaFzw5tWWSSNKn-DuKhiHUeYX5UHiEcnl_hzDJ9ZY,97
18
+ vsh_python-0.3.1.dist-info/entry_points.txt,sha256=gIJZgqX2nnROsGauWvfQf_SRIISWVZkWadCAnOQvics,82
19
+ vsh_python-0.3.1.dist-info/licenses/LICENSE,sha256=nF3tk9VMZH4eDwxSaavtaGgxvIHR_xavzSwQkLattHE,10951
20
+ vsh_python-0.3.1.dist-info/sboms/vsh-python.cyclonedx.json,sha256=rNnuEuGKLLLxmRGVc7t-iWoSdlqj_SdgU3EMkYhrU30,272502
21
+ vsh_python-0.3.1.dist-info/RECORD,,
@@ -0,0 +1,4 @@
1
+ Wheel-Version: 1.0
2
+ Generator: maturin (1.15.0)
3
+ Root-Is-Purelib: false
4
+ Tag: cp313-cp313-win_amd64
@@ -0,0 +1,3 @@
1
+ [console_scripts]
2
+ vsh=vsh.__main__:main
3
+ vsh-codemode=vsh.mcp.codemode_server:main
@@ -0,0 +1,190 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ Copyright 2026 vsh contributors
179
+
180
+ Licensed under the Apache License, Version 2.0 (the "License");
181
+ you may not use this file except in compliance with the License.
182
+ You may obtain a copy of the License at
183
+
184
+ http://www.apache.org/licenses/LICENSE-2.0
185
+
186
+ Unless required by applicable law or agreed to in writing, software
187
+ distributed under the License is distributed on an "AS IS" BASIS,
188
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189
+ See the License for the specific language governing permissions and
190
+ limitations under the License.