Skip to content

Commit 6e449a2

Browse files
committed
docs(README): explain about Wokwi and the library
also add link to the API docs
1 parent 37f8397 commit 6e449a2

File tree

2 files changed

+21
-2
lines changed

2 files changed

+21
-2
lines changed

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Changelog
22

3+
## 0.0.3 - 2025-07-01
4+
5+
- feat: add MicroPython + ESP32 example
6+
- docs: explain about Wokwi and the library
7+
38
## 0.0.2 - 2025-06-30
49

510
- chore: updated list of classifiers in `pyproject.toml`

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,19 @@ Typed, asyncio-friendly Python SDK for the **Wokwi Simulation API**
1111
1212
---
1313

14+
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.
15+
16+
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.
17+
1418
## Installation requirements
1519

16-
Python ≥ 3.9
20+
- Python ≥ 3.9
21+
- An API token from [https://wokwi.com/dashboard/ci](https://wokwi.com/dashboard/ci).
1722

18-
An API token from [https://wokwi.com/dashboard/ci](https://wokwi.com/dashboard/ci).
23+
Install the library with:
24+
```bash
25+
pip install wokwi-client
26+
```
1927

2028
## Running the examples
2129

@@ -33,6 +41,12 @@ pip install -e .[dev]
3341
python -m examples.hello_esp32.main
3442
```
3543

44+
For more examples, see the [examples](examples) directory.
45+
46+
## Documentation
47+
48+
The API documentation is available at [https://wokwi.github.io/wokwi-python-client/](https://wokwi.github.io/wokwi-python-client/).
49+
3650
## License
3751

3852
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)