Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ on:
- docs/**
- mkdocs.yml
- pyproject.toml
- README.md

permissions:
contents: read
Expand Down
7 changes: 5 additions & 2 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,19 @@ This guide will help you install the library, connect to your hub, and perform y

## Install pyOverkiz from PyPI

!!! note "Pre-release"
pyOverkiz v2 is currently in pre-release. Use the `--prerelease allow` (uv) or `--pre` (pip) flag until the stable release is available on PyPI.

### With UV <small>recommended</small>

```bash
uv add pyoverkiz
uv add pyoverkiz --prerelease allow
```

### With pip

```bash
pip install pyoverkiz
pip install --pre pyoverkiz
```

### Optional extras
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "pyoverkiz"
version = "2.0.0"
version = "2.0.0rc1"
description = "A fully asynchronous API client for interaction with smart devices connected to OverKiz, supporting multiple vendors such as Somfy TaHoma and Atlantic Cozytouch."
readme = "README.md"
authors = [
Expand Down
2 changes: 1 addition & 1 deletion tests/test_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -1217,7 +1217,7 @@ def test_user_agent_contains_version(self):
assert USER_AGENT.startswith("pyoverkiz/")
version_part = USER_AGENT.split("/", 1)[1]
assert version_part # not empty
assert all(c.isdigit() or c == "." for c in version_part)
assert all(c.isdigit() or c.isalpha() or c == "." for c in version_part)

@pytest.mark.asyncio
async def test_client_session_uses_user_agent(self):
Expand Down
2 changes: 1 addition & 1 deletion uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading