ucapi-framework 1.2.2__tar.gz → 1.6.4__tar.gz

{ucapi_framework-1.2.2/ucapi_framework.egg-info → ucapi_framework-1.6.4}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: ucapi-framework
-Version: 1.2.2
+Version: 1.6.4
 Summary: ucapi framework that provides core functionality for building integrations.
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 Requires-Dist: pyee>=9.0.0
-Requires-Dist: ucapi>=0.4.0
+Requires-Dist: ucapi>=0.5.1
 Requires-Dist: aiohttp>=3.9.0
 
 [![Tests](https://github.com/jackjpowell/ucapi-framework/actions/workflows/test.yml/badge.svg)](https://github.com/jackjpowell/ucapi-framework/actions/workflows/test.yml)
@@ -14,7 +14,7 @@ Requires-Dist: aiohttp>=3.9.0
 
 # UCAPI Framework
 
-A framework for building Unfolded Circle Remote integrations that handles the repetitive parts of integration development so you can focus on what's important.
+A framework for building Unfolded Circle Remote integrations that handles the repetitive parts of integration development so you can focus on what's important. Full documentation is available at [https://jackjpowell.github.io/ucapi-framework/](https://jackjpowell.github.io/ucapi-framework/)
 
 ## What This Solves
 
@@ -191,6 +191,9 @@ Total: ~295 lines of integration code vs ~885 lines previously. And the new code
 
 If you have an existing integration, see [MIGRATION_GUIDE.md](MIGRATION_GUIDE.md) for step-by-step instructions with before/after examples.
 
+For upgrading from a previous version of ucapi-framework:
+- **[Upgrading to 1.6.0](https://jackjpowell.github.io/ucapi-framework/upgrade-to-1.6.0/)** - New dynamic entity management features
+
 ## Requirements
 
 - Python 3.11+
@@ -219,6 +222,51 @@ mkdocs serve
 
 Visit <http://127.0.0.1:8000> to view the docs.
 
+## Development
+
+### Setup
+
+```bash
+# Install development dependencies (includes ruff)
+uv sync --group dev
+```
+
+Git hooks are automatically active from the `git-hooks/` directory:
+
+- **pre-commit**: Runs `ruff check --fix` and `ruff format` via `uv run`
+
+All development tools run through `uv` and are configured in `pyproject.toml`.
+
+### Code Quality
+
+This project uses [Ruff](https://github.com/astral-sh/ruff) for both linting and formatting.
+
+```bash
+# Run linter
+ruff check
+
+# Run linter with auto-fix
+ruff check --fix
+
+# Run formatter
+ruff format
+
+# Check formatting without making changes
+ruff format --check
+```
+
+Ruff is configured in `pyproject.toml` to match Black's formatting style and includes Flake8-compatible rules.
+
+### Testing
+
+```bash
+# Run all tests
+pytest
+
+# Run with coverage
+pytest --cov=ucapi_framework --cov-report=term-missing
+```
+
 ## License
 
 Mozilla Public License Version 2.0

ucapi_framework-1.2.2/PKG-INFO → ucapi_framework-1.6.4/README.md

@@ -1,20 +1,10 @@
-Metadata-Version: 2.4
-Name: ucapi-framework
-Version: 1.2.2
-Summary: ucapi framework that provides core functionality for building integrations.
-Requires-Python: >=3.11
-Description-Content-Type: text/markdown
-Requires-Dist: pyee>=9.0.0
-Requires-Dist: ucapi>=0.4.0
-Requires-Dist: aiohttp>=3.9.0
-
 [![Tests](https://github.com/jackjpowell/ucapi-framework/actions/workflows/test.yml/badge.svg)](https://github.com/jackjpowell/ucapi-framework/actions/workflows/test.yml)
 [![Discord](https://badgen.net/discord/online-members/zGVYf58)](https://discord.gg/zGVYf58)
 [![Buy Me A Coffee](https://img.shields.io/badge/Buy_Me_A_Coffee ☕-FFDD00?logo=buy-me-a-coffee&logoColor=white&labelColor=grey)](https://buymeacoffee.com/jackpowell)
 
 # UCAPI Framework
 
-A framework for building Unfolded Circle Remote integrations that handles the repetitive parts of integration development so you can focus on what's important.
+A framework for building Unfolded Circle Remote integrations that handles the repetitive parts of integration development so you can focus on what's important. Full documentation is available at [https://jackjpowell.github.io/ucapi-framework/](https://jackjpowell.github.io/ucapi-framework/)
 
 ## What This Solves
 
@@ -191,6 +181,9 @@ Total: ~295 lines of integration code vs ~885 lines previously. And the new code
 
 If you have an existing integration, see [MIGRATION_GUIDE.md](MIGRATION_GUIDE.md) for step-by-step instructions with before/after examples.
 
+For upgrading from a previous version of ucapi-framework:
+- **[Upgrading to 1.6.0](https://jackjpowell.github.io/ucapi-framework/upgrade-to-1.6.0/)** - New dynamic entity management features
+
 ## Requirements
 
 - Python 3.11+
@@ -219,6 +212,51 @@ mkdocs serve
 
 Visit <http://127.0.0.1:8000> to view the docs.
 
+## Development
+
+### Setup
+
+```bash
+# Install development dependencies (includes ruff)
+uv sync --group dev
+```
+
+Git hooks are automatically active from the `git-hooks/` directory:
+
+- **pre-commit**: Runs `ruff check --fix` and `ruff format` via `uv run`
+
+All development tools run through `uv` and are configured in `pyproject.toml`.
+
+### Code Quality
+
+This project uses [Ruff](https://github.com/astral-sh/ruff) for both linting and formatting.
+
+```bash
+# Run linter
+ruff check
+
+# Run linter with auto-fix
+ruff check --fix
+
+# Run formatter
+ruff format
+
+# Check formatting without making changes
+ruff format --check
+```
+
+Ruff is configured in `pyproject.toml` to match Black's formatting style and includes Flake8-compatible rules.
+
+### Testing
+
+```bash
+# Run all tests
+pytest
+
+# Run with coverage
+pytest --cov=ucapi_framework --cov-report=term-missing
+```
+
 ## License
 
 Mozilla Public License Version 2.0

ucapi_framework-1.6.4/pyproject.toml

@@ -0,0 +1,102 @@
+[project]
+name = "ucapi-framework"
+version = "1.6.4"
+description = "ucapi framework that provides core functionality for building integrations."
+readme = "README.md"
+requires-python = ">=3.11"
+dependencies = [
+    "pyee>=9.0.0",
+    "ucapi>=0.5.1",
+    "aiohttp>=3.9.0",
+]
+
+[dependency-groups]
+dev = [
+    "pytest>=9.0.1",
+    "pytest-asyncio>=0.23.0",
+    "pytest-cov>=4.1.0",
+    "ruff>=0.8.0",
+    "ty>=0.0.4",
+]
+docs = [
+    "mkdocs-material>=9.5.0",
+    "mkdocstrings[python]>=0.24.0",
+    "mkdocstrings-python>=1.0.0",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+python_classes = ["Test*"]
+python_functions = ["test_*"]
+asyncio_mode = "auto"
+addopts = [
+    "-v",
+    "--tb=short",
+    "--strict-markers",
+]
+
+[tool.ruff]
+# Exclude a variety of commonly ignored directories.
+exclude = [
+    ".bzr",
+    ".direnv",
+    ".eggs",
+    ".git",
+    ".git-rewrite",
+    ".hg",
+    ".ipynb_checkpoints",
+    ".mypy_cache",
+    ".nox",
+    ".pants.d",
+    ".pyenv",
+    ".pytest_cache",
+    ".pytype",
+    ".ruff_cache",
+    ".svn",
+    ".tox",
+    ".venv",
+    ".vscode",
+    "__pypackages__",
+    "_build",
+    "buck-out",
+    "build",
+    "dist",
+    "node_modules",
+    "site-packages",
+    "venv",
+]
+
+# Same as Black.
+line-length = 88
+indent-width = 4
+
+# Assume Python 3.11
+target-version = "py311"
+
+[tool.ruff.lint]
+# Enable Pyflakes (`F`) and a subset of the pycodestyle (`E`)  codes by default.
+# Unlike Flake8, Ruff doesn't enable pycodestyle warnings (`W`) or
+# McCabe complexity (`C901`) by default.
+select = ["E4", "E7", "E9", "F"]
+ignore = []
+
+# Allow fix for all enabled rules (when `--fix`) is provided.
+fixable = ["ALL"]
+unfixable = []
+
+# Allow unused variables when underscore-prefixed.
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+[tool.ruff.format]
+# Like Black, use double quotes for strings.
+quote-style = "double"
+
+# Like Black, indent with spaces, rather than tabs.
+indent-style = "space"
+
+# Like Black, respect magic trailing commas.
+skip-magic-trailing-comma = false
+
+# Like Black, automatically detect the appropriate line ending.
+line-ending = "auto"

{ucapi_framework-1.2.2 → ucapi_framework-1.6.4}/tests/test_device.py

@@ -536,39 +536,6 @@ class TestStatelessHTTPDevice:
         assert device._is_connected is False
         assert len(events_emitted) == 1
 
-    @pytest.mark.asyncio
-    @pytest.mark.asyncio
-    @pytest.mark.skip(
-        reason="Complex async context manager mocking - implementation verified manually"
-    )
-    async def test_http_request(self, mock_device_config, event_loop):
-        """Test HTTP request method."""
-        device = ConcreteStatelessHTTPDevice(mock_device_config, loop=event_loop)
-
-        mock_response = AsyncMock()
-        mock_response.raise_for_status = Mock()
-        mock_response.status = 200
-
-        with patch("aiohttp.ClientSession") as mock_session_class:
-            mock_session = AsyncMock()
-            mock_session.__aenter__.return_value = mock_session
-            mock_session.__aexit__.return_value = AsyncMock()
-
-            # Create a proper async context manager for the request
-            mock_request_ctx = AsyncMock()
-            mock_request_ctx.__aenter__.return_value = mock_response
-            mock_request_ctx.__aexit__.return_value = AsyncMock()
-            mock_session.request.return_value = mock_request_ctx
-
-            mock_session_class.return_value = mock_session
-
-            # Just verify the request completes without error
-            # Note: The response object can't be tested directly since it's used within a context manager
-            mock_session.request.assert_not_called()  # Before call
-            await device._http_request("GET", "http://test.com")
-            mock_session.request.assert_called_once_with("GET", "http://test.com")
-            mock_response.raise_for_status.assert_called_once()
-
 
 class TestPollingDevice:
     """Tests for PollingDevice."""
@@ -1001,32 +968,6 @@ class TestPersistentConnectionDevice:
 
         assert device.connection_closed is True
 
-    @pytest.mark.asyncio
-    @pytest.mark.skip(reason="Timing-sensitive test - reconnection backoff varies")
-    async def test_reconnection_with_backoff(self, mock_device_config, event_loop):
-        """Test reconnection with exponential backoff."""
-
-        class FailingDevice(ConcretePersistentConnectionDevice):
-            def __init__(self, *args, **kwargs):
-                super().__init__(*args, **kwargs)
-                self.connection_attempts = 0
-
-            async def establish_connection(self):
-                self.connection_attempts += 1
-                if self.connection_attempts < 3:
-                    raise Exception("Connection failed")
-                return await super().establish_connection()
-
-        device = FailingDevice(mock_device_config, loop=event_loop, backoff_max=1)
-
-        await device.connect()
-        await asyncio.sleep(1.5)  # Wait for reconnection attempts with backoff
-
-        # Should have made multiple connection attempts
-        assert device.connection_attempts >= 2
-
-        await device.disconnect()
-
     @pytest.mark.asyncio
     async def test_maintain_connection_called(self, mock_device_config, event_loop):
         """Test that maintain_connection is called after connection."""
@@ -1455,12 +1396,12 @@ class TestDeviceEvents:
 
     def test_device_events_values(self):
         """Test that DeviceEvents enum has expected values."""
-        assert DeviceEvents.CONNECTING == 0
-        assert DeviceEvents.CONNECTED == 1
-        assert DeviceEvents.DISCONNECTED == 2
-        assert DeviceEvents.PAIRED == 3
-        assert DeviceEvents.ERROR == 4
-        assert DeviceEvents.UPDATE == 5
+        assert DeviceEvents.CONNECTING == "DEVICE_CONNECTING"
+        assert DeviceEvents.CONNECTED == "DEVICE_CONNECTED"
+        assert DeviceEvents.DISCONNECTED == "DEVICE_DISCONNECTED"
+        assert DeviceEvents.PAIRED == "DEVICE_PAIRED"
+        assert DeviceEvents.ERROR == "DEVICE_ERROR"
+        assert DeviceEvents.UPDATE == "DEVICE_UPDATE"
 
 
 class ConcreteExternalClientDevice(ExternalClientDevice):