Skip to content

Add wasmtime version compatibility note on README #192

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dicej merged 2 commits into from
Jan 12, 2026
Merged

Add wasmtime version compatibility note on README #192

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f92aa18
fix: update README to clarify compatibility with Wasmtime versions
melizalde-ds Jan 12, 2026
efb6b53
fix: correct reference to wasmtime-py in compatibility note
melizalde-ds Jan 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
**A [Bytecode Alliance](https://bytecodealliance.org/) project**

This is a tool to convert a Python application to a [WebAssembly
component](https://github.com/WebAssembly/component-model). It takes the
component](https://github.com/WebAssembly/component-model). It takes the
following as input:

- a [WIT](https://github.com/WebAssembly/component-model/blob/main/design/mvp/WIT.md) file or directory
Expand All @@ -17,7 +17,7 @@ e.g. [`wasmtime`](https://github.com/bytecodealliance/wasmtime).
## Getting Started

First, install [Python 3.10 or later](https://www.python.org/) and
[pip](https://pypi.org/project/pip/) if you don't already have them. Then,
[pip](https://pypi.org/project/pip/) if you don't already have them. Then,
install `componentize-py`:

```shell
Expand Down Expand Up @@ -62,6 +62,9 @@ componentize-py -d hello.wit -w hello componentize --stub-wasi app -o app.wasm
To test it, you can install `wasmtime-py` and use it to generate host-side
bindings for the component:

> [!NOTE]
> Due to compatibility issues with `wasmtime-py` versions beyond 38.x, **this example** requires version 38.0.0 or earlier: `pip install "wasmtime==38.0.0"`

```shell
pip install wasmtime
python3 -m wasmtime.bindgen app.wasm --out-dir hello_host
Expand Down Expand Up @@ -99,7 +102,7 @@ created.

Currently, the application can only import dependencies during build time, which
means any imports used at runtime must be resolved at the top level of the
application module. For example, if `x` is a module with a submodule named `y`
application module. For example, if `x` is a module with a submodule named `y`
the following may not work:

```python
Expand All @@ -110,7 +113,7 @@ class Hello(hello.Hello):
return x.y.foo()
```

That's because importing `x` does not necessarily resolve `y`. This can be
That's because importing `x` does not necessarily resolve `y`. This can be
addressed by modifying the code to import `y` at the top level of the file:

```python
Expand Down