File tree Expand file tree Collapse file tree 3 files changed +25
-13
lines changed
Expand file tree Collapse file tree 3 files changed +25
-13
lines changed Original file line number Diff line number Diff line change @@ -14,6 +14,18 @@ Install git hooks:
1414uv run prek install
1515```
1616
17+ ## Run the docs locally
18+
19+ ``` bash
20+ uv run mkdocs serve
21+ ```
22+
23+ Docs will be available at http://localhost:8000 .
24+
25+ ``` bash
26+ uv run mkdocs build
27+ ```
28+
1729## Tests and linting
1830
1931``` bash
Original file line number Diff line number Diff line change 22
33## Prerequisites
44
5- - Python 3.10–3.13
6- - uv
5+ - Python 3.10+
76- An OverKiz-compatible hub and account
87
9- ## Install dependencies
8+ ## Install pyOverkiz from PyPi
109
1110``` bash
12- uv sync
11+ pip install pyoverkiz
1312```
1413
15- ## Run the docs locally
14+ If you use uv:
1615
1716``` bash
18- uv run mkdocs serve
19- ```
20-
21- Docs will be available at http://localhost:8000 .
22-
23- ``` bash
24- uv run mkdocs build
17+ uv add pyoverkiz
2518```
2619
2720## Choose your server
@@ -98,4 +91,11 @@ async def main() -> None:
9891
9992
10093asyncio.run(main())
94+
95+ # # Next steps
96+
97+ - Learn about authentication flows in [docs/ authentication.md](docs/ authentication.md).
98+ - Control devices and run actions in [docs/ device- control.md](docs/ device- control.md).
99+ - Handle events in [docs/ event- handling.md](docs/ event- handling.md).
100+ - Understand errors in [docs/ error- handling.md](docs/ error- handling.md).
101101```
Original file line number Diff line number Diff line change 4040 - Event handling : event-handling.md
4141 - Error handling : error-handling.md
4242 - Troubleshooting : troubleshooting.md
43- - Contribute : contribute.md
4443 - API Reference : api-reference.md
44+ - Contribute : contribute.md
You can’t perform that action at this time.
0 commit comments