diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index c1183a52..d46efc22 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -9,7 +9,6 @@ on: - docs/** - mkdocs.yml - pyproject.toml - - README.md permissions: contents: read diff --git a/docs/getting-started.md b/docs/getting-started.md index 0e90305a..6ec57f1b 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -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 recommended ```bash -uv add pyoverkiz +uv add pyoverkiz --prerelease allow ``` ### With pip ```bash -pip install pyoverkiz +pip install --pre pyoverkiz ``` ### Optional extras diff --git a/pyproject.toml b/pyproject.toml index 725ff323..df723d23 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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 = [ diff --git a/tests/test_client.py b/tests/test_client.py index bb3b6c63..023cccd8 100644 --- a/tests/test_client.py +++ b/tests/test_client.py @@ -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): diff --git a/uv.lock b/uv.lock index 087387f0..99db6d82 100644 --- a/uv.lock +++ b/uv.lock @@ -1004,7 +1004,7 @@ wheels = [ [[package]] name = "pyoverkiz" -version = "2.0.0" +version = "2.0.0rc1" source = { editable = "." } dependencies = [ { name = "aiohttp" },