# Wokwi Python Client 🚀
Typed, asyncio-friendly Python SDK for the **Wokwi Simulation API**
[](https://pypi.org/project/wokwi-client/)
[](https://pypi.org/project/wokwi-client/)
[](https://github.com/wokwi/wokwi-python-client/actions/workflows/ci.yaml)
[](LICENSE)
> **TL;DR:** Run and control your Wokwi simulations from Python with first-class type hints and zero boilerplate.
---
Wokwi is a platform for creating and running simulations of electronic circuits and embedded systems. It supports a wide range of hardware platforms, including ESP32 family, Arduino, Raspberry Pi, STM32 and more.In addition, it supports a [wide range of peripherals](https://docs.wokwi.com/getting-started/supported-hardware), including sensors, displays, motors, and debugging tools.
Wokwi Python Client is a Python SDK for the Wokwi Simulation API. It allows you to run and control your Wokwi simulations from Python in a typed, asyncio-friendly way. You can use it to automate your embedded testing and development workflows.
## Installation requirements
- Python ≥ 3.9
- An API token from [https://wokwi.com/dashboard/ci](https://wokwi.com/dashboard/ci).
Install the library with:
```bash
pip install wokwi-client
```
## Running the examples
The basic example is in the [examples/hello_esp32/main.py](examples/hello_esp32/main.py) file. It shows how to:
- Connect to the Wokwi Simulator
- Upload a diagram and firmware files
- Start a simulation
- Monitor the serial output
You can run the example with:
```bash
pip install -e .[dev]
python -m examples.hello_esp32.main
```
For more examples, see the [examples](examples) directory.
## Documentation
The API documentation is available at [https://wokwi.github.io/wokwi-python-client/](https://wokwi.github.io/wokwi-python-client/).
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": null,
"name": "wokwi-client",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "api, arduino, asyncio, avr, esp32, python, rp2040, simulation, wokwi",
"author": null,
"author_email": "Uri Shaked <uri@wokwi.com>",
"download_url": "https://files.pythonhosted.org/packages/68/51/187f029477116b86c5d14d8484f0c663fbebb596dd72785df0c5c448152c/wokwi_client-0.0.5.tar.gz",
"platform": null,
"description": "# Wokwi Python Client \ud83d\ude80\n\nTyped, asyncio-friendly Python SDK for the **Wokwi Simulation API**\n\n[](https://pypi.org/project/wokwi-client/)\n[](https://pypi.org/project/wokwi-client/)\n[](https://github.com/wokwi/wokwi-python-client/actions/workflows/ci.yaml)\n[](LICENSE)\n\n> **TL;DR:** Run and control your Wokwi simulations from Python with first-class type hints and zero boilerplate.\n\n---\n\nWokwi is a platform for creating and running simulations of electronic circuits and embedded systems. It supports a wide range of hardware platforms, including ESP32 family, Arduino, Raspberry Pi, STM32 and more.In addition, it supports a [wide range of peripherals](https://docs.wokwi.com/getting-started/supported-hardware), including sensors, displays, motors, and debugging tools.\n\nWokwi Python Client is a Python SDK for the Wokwi Simulation API. It allows you to run and control your Wokwi simulations from Python in a typed, asyncio-friendly way. You can use it to automate your embedded testing and development workflows.\n\n## Installation requirements\n\n- Python \u2265 3.9\n- An API token from [https://wokwi.com/dashboard/ci](https://wokwi.com/dashboard/ci).\n\nInstall the library with:\n```bash\npip install wokwi-client\n```\n\n## Running the examples\n\nThe basic example is in the [examples/hello_esp32/main.py](examples/hello_esp32/main.py) file. It shows how to:\n\n- Connect to the Wokwi Simulator\n- Upload a diagram and firmware files\n- Start a simulation\n- Monitor the serial output\n\nYou can run the example with:\n\n```bash\npip install -e .[dev]\npython -m examples.hello_esp32.main\n```\n\nFor more examples, see the [examples](examples) directory.\n\n## Documentation\n\nThe API documentation is available at [https://wokwi.github.io/wokwi-python-client/](https://wokwi.github.io/wokwi-python-client/).\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n",
"bugtrack_url": null,
"license": null,
"summary": "Typed, asyncio-friendly Python SDK for the Wokwi Simulation API",
"version": "0.0.5",
"project_urls": {
"Documentation": "https://github.com/wokwi/wokwi-python-client#readme",
"Issues": "https://github.com/wokwi/wokwi-python-client/issues",
"Source": "https://github.com/wokwi/wokwi-python-client"
},
"split_keywords": [
"api",
" arduino",
" asyncio",
" avr",
" esp32",
" python",
" rp2040",
" simulation",
" wokwi"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "d8505bd4717b8222d69fc9897b9896dae5c23d5cc35622910145bf82feaae63e",
"md5": "133d2f184bd53c7e6a72b2b95017127e",
"sha256": "3659c3d91743949d0e75259981183d489ce618c748272bcddbbe49612d44427d"
},
"downloads": -1,
"filename": "wokwi_client-0.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "133d2f184bd53c7e6a72b2b95017127e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 13394,
"upload_time": "2025-08-15T10:14:03",
"upload_time_iso_8601": "2025-08-15T10:14:03.238191Z",
"url": "https://files.pythonhosted.org/packages/d8/50/5bd4717b8222d69fc9897b9896dae5c23d5cc35622910145bf82feaae63e/wokwi_client-0.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "6851187f029477116b86c5d14d8484f0c663fbebb596dd72785df0c5c448152c",
"md5": "18a5a308a98f8186a40459d353359e5b",
"sha256": "d931e5aaad4e4235709542a7321c7afec61b3f12755ea28f2837b69d5b38723a"
},
"downloads": -1,
"filename": "wokwi_client-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "18a5a308a98f8186a40459d353359e5b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 12274,
"upload_time": "2025-08-15T10:14:04",
"upload_time_iso_8601": "2025-08-15T10:14:04.643428Z",
"url": "https://files.pythonhosted.org/packages/68/51/187f029477116b86c5d14d8484f0c663fbebb596dd72785df0c5c448152c/wokwi_client-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-15 10:14:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "wokwi",
"github_project": "wokwi-python-client#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "wokwi-client"
}
JSON
