microvm

A lightweight microservice VM framework for distributed applications.

Installation

Install MicroVM from PyPI:

python -m pip install microvm
microvm --help

For local development from a checkout:

python -m pip install -e ".[dev]"

Quick Start

Extract Bundled Examples

The PyPI package includes the repository docs, examples, and demo assets. Copy them into a working directory before running the example workspaces:

microvm bundle list
microvm bundle extract C:\Users\Public\Public\microvm-bundle

Inspect a Workspace

View the structure and components of a workspace:

microvm inspect /workspace/examples/pong-microvm

Run a Workspace

Execute all MicroVM components in a workspace:

microvm --runtime-root /workspace/.runtime run /workspace/examples/pong-microvm

Example: Pong MicroVM Demo

The examples/pong-microvm workspace demonstrates five MicroVM components:

• web: full-screen HTML5 canvas Pong.
• matchmaking: LAN scan, invite/accept, game events, and MMUKO state.
• polycall: native PolyCall detection plus adapter fallback stream.
• voice: voice-channel negotiation events.
• u-agent: adaptive practice opponent named u.

microvm inspect examples/pong-microvm
microvm --runtime-root .runtime run examples/pong-microvm

Then open:

http://127.0.0.1:8890

Runtime State

python -m unittest tests/test_microvm_cli.py
python -m unittest discover -s tests -v

Build and Publish

Build local distribution artifacts:

python -m build
python -m twine check dist/*

Publish to TestPyPI first, then PyPI, using trusted publishing or local credentials. Do not commit package tokens or API keys.

Production releases are published from GitHub Actions when a v* tag is pushed. See docs/PUBLISHING.md for the one-time trusted publisher setup and release checklist.