Skip to content

Commit 4f60bea

Browse files
committed
docs(README): development instructions
1 parent 5a1a91c commit 4f60bea

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,27 @@ For more examples, see the [examples](examples) directory.
4747

4848
The API documentation is available at [https://wokwi.github.io/wokwi-python-client/](https://wokwi.github.io/wokwi-python-client/).
4949

50+
## Development
51+
52+
To run the tests, set the `WOKWI_CLI_TOKEN` environment variable (you can get a token from [https://wokwi.com/dashboard/ci](https://wokwi.com/dashboard/ci)) and run the following command:
53+
54+
```bash
55+
hatch run dev:pytest
56+
```
57+
58+
To run the linter, run the following command:
59+
60+
```bash
61+
hatch run ruff format --check .
62+
hatch run ruff check .
63+
```
64+
65+
To run the type checker, run the following command:
66+
67+
```bash
68+
hatch run mypy .
69+
```
70+
5071
## License
5172

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

0 commit comments

Comments
 (0)