Skip to content

wokwi/wokwi-python-client

Repository files navigation

Wokwi Python Client 🚀

Typed, asyncio-friendly Python SDK for the Wokwi Simulation API

PyPI version Python versions CI License: MIT

TL;DR: Run and control your Wokwi simulations from Python with first-class type hints and zero boilerplate.


Installation requirements

Python ≥ 3.9

An API token from https://wokwi.com/dashboard/ci.

Running the examples

The basic example is in the 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:

pip install -e .[dev]
python -m examples.hello_esp32.main

License

This project is licensed under the MIT License. See the LICENSE file for details.

Releases

No releases published

Packages

No packages published

Languages