wasm-micro-runtime/language-bindings/python/wamr-api/README.md

# WARM API

* **Notice**: The python package `wamr.wamrapi.wamr` need python >= `3.10`.

## Setup

### Pre-requisites

Install requirements,

```shell
pip install -r requirements.txt
```

### Build native lib and update bindings

The following command builds the iwasm library and generates the Python bindings,

```sh
# In WAMR root directory
bash language-bindings/python/utils/create_lib.sh
```

This will build and copy libiwasm into the package.

## Samples

- **[basic](./samples/basic)**: Demonstrating how to use basic python bindings.
- **[native-symbol](./samples/native-symbol)**: Desmostrate how to call WASM from Python and how to export Python functions into WASM.
Add WAMR API bindings in Python (#1959) Before adding the new bindings: 1. Moved wasm-c-api in a subfolder wasmcapi in the package. 2. Adapted the tests to be able to run in this new structure. New: 1. Added the WAMR API in another folder wamrapi in the same level as wasm-c-api. 2. Created an OOP proposal. 3. Added an example using this proposal. 2023-02-16 07:21:28 +00:00			`# WARM API`

Small refactor on WASMModuleInstance and fix Go/Python language bindings (#3227) - Merge unused field `used_to_be_wasi_ctx` in `AOTModuleInstance` into `reserved` area - Add field `memory_lock` in `WASMMemoryInstance` for future refactor - Go binding: fix type error https://github.com/bytecodealliance/wasm-micro-runtime/issues/3220 - Python binding: type annotation uses the union operator "\|", which requires Python version >=3.10 2024-03-14 07:30:28 +00:00			* Notice: The python package `wamr.wamrapi.wamr` need python >= `3.10`.
The Python language-binding needs python>=3.9 (#2228) Update python language binding setup.py and document Make compile.sh executable: `chmod +x compile.sh` 2023-05-24 00:15:28 +00:00
Python WAMR API binding: Add malloc/free and register_native (#1989) 2023-02-28 08:19:17 +00:00			`## Setup`
Add WAMR API bindings in Python (#1959) Before adding the new bindings: 1. Moved wasm-c-api in a subfolder wasmcapi in the package. 2. Adapted the tests to be able to run in this new structure. New: 1. Added the WAMR API in another folder wamrapi in the same level as wasm-c-api. 2. Created an OOP proposal. 3. Added an example using this proposal. 2023-02-16 07:21:28 +00:00
Python WAMR API binding: Add malloc/free and register_native (#1989) 2023-02-28 08:19:17 +00:00			`### Pre-requisites`
Add WAMR API bindings in Python (#1959) Before adding the new bindings: 1. Moved wasm-c-api in a subfolder wasmcapi in the package. 2. Adapted the tests to be able to run in this new structure. New: 1. Added the WAMR API in another folder wamrapi in the same level as wasm-c-api. 2. Created an OOP proposal. 3. Added an example using this proposal. 2023-02-16 07:21:28 +00:00
Python WAMR API binding: Add malloc/free and register_native (#1989) 2023-02-28 08:19:17 +00:00			`Install requirements,`
Add WAMR API bindings in Python (#1959) Before adding the new bindings: 1. Moved wasm-c-api in a subfolder wasmcapi in the package. 2. Adapted the tests to be able to run in this new structure. New: 1. Added the WAMR API in another folder wamrapi in the same level as wasm-c-api. 2. Created an OOP proposal. 3. Added an example using this proposal. 2023-02-16 07:21:28 +00:00
Small refactor on WASMModuleInstance and fix Go/Python language bindings (#3227) - Merge unused field `used_to_be_wasi_ctx` in `AOTModuleInstance` into `reserved` area - Add field `memory_lock` in `WASMMemoryInstance` for future refactor - Go binding: fix type error https://github.com/bytecodealliance/wasm-micro-runtime/issues/3220 - Python binding: type annotation uses the union operator "\|", which requires Python version >=3.10 2024-03-14 07:30:28 +00:00			```shell
Python WAMR API binding: Add malloc/free and register_native (#1989) 2023-02-28 08:19:17 +00:00			`pip install -r requirements.txt`
Add WAMR API bindings in Python (#1959) Before adding the new bindings: 1. Moved wasm-c-api in a subfolder wasmcapi in the package. 2. Adapted the tests to be able to run in this new structure. New: 1. Added the WAMR API in another folder wamrapi in the same level as wasm-c-api. 2. Created an OOP proposal. 3. Added an example using this proposal. 2023-02-16 07:21:28 +00:00			```

Python WAMR API binding: Add malloc/free and register_native (#1989) 2023-02-28 08:19:17 +00:00			`### Build native lib and update bindings`
Add WAMR API bindings in Python (#1959) Before adding the new bindings: 1. Moved wasm-c-api in a subfolder wasmcapi in the package. 2. Adapted the tests to be able to run in this new structure. New: 1. Added the WAMR API in another folder wamrapi in the same level as wasm-c-api. 2. Created an OOP proposal. 3. Added an example using this proposal. 2023-02-16 07:21:28 +00:00
Python WAMR API binding: Add malloc/free and register_native (#1989) 2023-02-28 08:19:17 +00:00			`The following command builds the iwasm library and generates the Python bindings,`
Add WAMR API bindings in Python (#1959) Before adding the new bindings: 1. Moved wasm-c-api in a subfolder wasmcapi in the package. 2. Adapted the tests to be able to run in this new structure. New: 1. Added the WAMR API in another folder wamrapi in the same level as wasm-c-api. 2. Created an OOP proposal. 3. Added an example using this proposal. 2023-02-16 07:21:28 +00:00
Python WAMR API binding: Add malloc/free and register_native (#1989) 2023-02-28 08:19:17 +00:00			```sh
Small refactor on WASMModuleInstance and fix Go/Python language bindings (#3227) - Merge unused field `used_to_be_wasi_ctx` in `AOTModuleInstance` into `reserved` area - Add field `memory_lock` in `WASMMemoryInstance` for future refactor - Go binding: fix type error https://github.com/bytecodealliance/wasm-micro-runtime/issues/3220 - Python binding: type annotation uses the union operator "\|", which requires Python version >=3.10 2024-03-14 07:30:28 +00:00			`# In WAMR root directory`
Python WAMR API binding: Add malloc/free and register_native (#1989) 2023-02-28 08:19:17 +00:00			`bash language-bindings/python/utils/create_lib.sh`
Add WAMR API bindings in Python (#1959) Before adding the new bindings: 1. Moved wasm-c-api in a subfolder wasmcapi in the package. 2. Adapted the tests to be able to run in this new structure. New: 1. Added the WAMR API in another folder wamrapi in the same level as wasm-c-api. 2. Created an OOP proposal. 3. Added an example using this proposal. 2023-02-16 07:21:28 +00:00			```

Python WAMR API binding: Add malloc/free and register_native (#1989) 2023-02-28 08:19:17 +00:00			`This will build and copy libiwasm into the package.`
Add WAMR API bindings in Python (#1959) Before adding the new bindings: 1. Moved wasm-c-api in a subfolder wasmcapi in the package. 2. Adapted the tests to be able to run in this new structure. New: 1. Added the WAMR API in another folder wamrapi in the same level as wasm-c-api. 2. Created an OOP proposal. 3. Added an example using this proposal. 2023-02-16 07:21:28 +00:00
wamr-python: Enable debugging WASM and grant dir access (#2449) - Enable debugging a WASM loaded and executed from Python. - Expose API to enable access to list of host directories. Similar to --dir in iwasm. - Add another python language binding sample: native-symbol. 2023-08-15 02:32:43 +00:00			`## Samples`
Python WAMR API binding: Add malloc/free and register_native (#1989) 2023-02-28 08:19:17 +00:00
wamr-python: Enable debugging WASM and grant dir access (#2449) - Enable debugging a WASM loaded and executed from Python. - Expose API to enable access to list of host directories. Similar to --dir in iwasm. - Add another python language binding sample: native-symbol. 2023-08-15 02:32:43 +00:00			`- [basic](./samples/basic): Demonstrating how to use basic python bindings.`
			`- [native-symbol](./samples/native-symbol): Desmostrate how to call WASM from Python and how to export Python functions into WASM.`