Align docs and Makefile with public release surface
This commit is contained in:
parent
f3e7d4aa3e
commit
89f3d6f012
7 changed files with 14 additions and 8 deletions
|
|
@ -48,7 +48,7 @@ These checks run in pre-commit hooks and should all pass locally.
|
||||||
- Primary tool:
|
- Primary tool:
|
||||||
- `vm_run`
|
- `vm_run`
|
||||||
- Advanced lifecycle tools:
|
- Advanced lifecycle tools:
|
||||||
- `vm_list_profiles`
|
- `vm_list_environments`
|
||||||
- `vm_create`
|
- `vm_create`
|
||||||
- `vm_start`
|
- `vm_start`
|
||||||
- `vm_exec`
|
- `vm_exec`
|
||||||
|
|
|
||||||
6
Makefile
6
Makefile
|
|
@ -21,7 +21,7 @@ help:
|
||||||
' typecheck Run mypy' \
|
' typecheck Run mypy' \
|
||||||
' test Run pytest' \
|
' test Run pytest' \
|
||||||
' check Run lint, typecheck, and tests' \
|
' check Run lint, typecheck, and tests' \
|
||||||
' dist-check Smoke-test the installed public pyro CLI entrypoint' \
|
' dist-check Smoke-test the installed pyro CLI and environment UX' \
|
||||||
' demo Run the deterministic VM demo' \
|
' demo Run the deterministic VM demo' \
|
||||||
' network-demo Run the deterministic VM demo with guest networking enabled' \
|
' network-demo Run the deterministic VM demo with guest networking enabled' \
|
||||||
' doctor Show runtime and host diagnostics' \
|
' doctor Show runtime and host diagnostics' \
|
||||||
|
|
@ -64,7 +64,11 @@ check: lint typecheck test
|
||||||
dist-check:
|
dist-check:
|
||||||
.venv/bin/pyro --version
|
.venv/bin/pyro --version
|
||||||
.venv/bin/pyro --help >/dev/null
|
.venv/bin/pyro --help >/dev/null
|
||||||
|
.venv/bin/pyro mcp --help >/dev/null
|
||||||
|
.venv/bin/pyro run --help >/dev/null
|
||||||
.venv/bin/pyro env list >/dev/null
|
.venv/bin/pyro env list >/dev/null
|
||||||
|
.venv/bin/pyro env inspect debian:12 >/dev/null
|
||||||
|
.venv/bin/pyro doctor >/dev/null
|
||||||
|
|
||||||
demo:
|
demo:
|
||||||
uv run pyro demo
|
uv run pyro demo
|
||||||
|
|
|
||||||
|
|
@ -35,7 +35,7 @@ The public user-facing interface is `pyro` and `Pyro`.
|
||||||
|
|
||||||
## Official Environments
|
## Official Environments
|
||||||
|
|
||||||
Current curated environments in this repository:
|
Current official environments in the shipped catalog:
|
||||||
|
|
||||||
- `debian:12`
|
- `debian:12`
|
||||||
- `debian:12-base`
|
- `debian:12-base`
|
||||||
|
|
@ -89,7 +89,7 @@ Run the Ollama demo:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
ollama serve
|
ollama serve
|
||||||
ollama pull llama:3.2-3b
|
ollama pull llama3.2:3b
|
||||||
pyro demo ollama
|
pyro demo ollama
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -6,7 +6,7 @@
|
||||||
|
|
||||||
- KVM available at `/dev/kvm`
|
- KVM available at `/dev/kvm`
|
||||||
- support for Firecracker microVMs
|
- support for Firecracker microVMs
|
||||||
- sufficient disk for the bundled runtime images
|
- sufficient disk for the embedded runtime files and cached OCI environment images
|
||||||
|
|
||||||
## Required For Guest Networking
|
## Required For Guest Networking
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -35,9 +35,10 @@ uvx --from pyro-mcp pyro env list
|
||||||
## Installed CLI
|
## Installed CLI
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
uv tool install .
|
uv tool install pyro-mcp
|
||||||
pyro --version
|
pyro --version
|
||||||
pyro env list
|
pyro env list
|
||||||
|
pyro env inspect debian:12
|
||||||
pyro doctor
|
pyro doctor
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -7,6 +7,7 @@ This document defines the supported public interface for `pyro-mcp` `1.x`.
|
||||||
- Distribution name: `pyro-mcp`
|
- Distribution name: `pyro-mcp`
|
||||||
- Public executable: `pyro`
|
- Public executable: `pyro`
|
||||||
- Public Python import: `from pyro_mcp import Pyro`
|
- Public Python import: `from pyro_mcp import Pyro`
|
||||||
|
- Public package-level factory: `from pyro_mcp import create_server`
|
||||||
|
|
||||||
## CLI Contract
|
## CLI Contract
|
||||||
|
|
||||||
|
|
@ -46,7 +47,7 @@ Primary facade:
|
||||||
|
|
||||||
Supported public methods:
|
Supported public methods:
|
||||||
|
|
||||||
- `create_server()`
|
- `Pyro.create_server()`
|
||||||
- `list_environments()`
|
- `list_environments()`
|
||||||
- `pull_environment(environment)`
|
- `pull_environment(environment)`
|
||||||
- `inspect_environment(environment)`
|
- `inspect_environment(environment)`
|
||||||
|
|
|
||||||
|
|
@ -14,7 +14,7 @@ from pyro_mcp.api import Pyro
|
||||||
__all__ = ["Pyro", "run_ollama_tool_demo"]
|
__all__ = ["Pyro", "run_ollama_tool_demo"]
|
||||||
|
|
||||||
DEFAULT_OLLAMA_BASE_URL: Final[str] = "http://localhost:11434/v1"
|
DEFAULT_OLLAMA_BASE_URL: Final[str] = "http://localhost:11434/v1"
|
||||||
DEFAULT_OLLAMA_MODEL: Final[str] = "llama:3.2-3b"
|
DEFAULT_OLLAMA_MODEL: Final[str] = "llama3.2:3b"
|
||||||
MAX_TOOL_ROUNDS: Final[int] = 12
|
MAX_TOOL_ROUNDS: Final[int] = 12
|
||||||
CLONE_TARGET_DIR: Final[str] = "hello-world"
|
CLONE_TARGET_DIR: Final[str] = "hello-world"
|
||||||
NETWORK_PROOF_COMMAND: Final[str] = (
|
NETWORK_PROOF_COMMAND: Final[str] = (
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue