eero-api 1.2.4__tar.gz

eero_api-1.2.4/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Eero API Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

eero_api-1.2.4/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.4
+Name: eero-api
+Version: 1.2.4
+Summary: Modern async Python client for Eero network management
+Author: Eero API Contributors
+Maintainer: Eero API Contributors
+License: MIT
+Project-URL: Homepage, https://github.com/fulviofreitas/eero-api
+Project-URL: Documentation, https://github.com/fulviofreitas/eero-api/wiki
+Project-URL: Repository, https://github.com/fulviofreitas/eero-api
+Project-URL: Changelog, https://github.com/fulviofreitas/eero-api/blob/master/CHANGELOG.md
+Project-URL: Issues, https://github.com/fulviofreitas/eero-api/issues
+Keywords: eero,mesh-wifi,wifi,network,async,asyncio,home-automation,smart-home,api-client,iot
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Home Automation
+Classifier: Topic :: Internet
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Networking
+Classifier: Typing :: Typed
+Classifier: Framework :: AsyncIO
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp>=3.8.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: keyring>=23.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: isort>=5.12.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Requires-Dist: rich>=13.0.0; extra == "dev"
+Requires-Dist: click>=8.0.0; extra == "dev"
+Requires-Dist: commitizen>=3.0.0; extra == "dev"
+Dynamic: license-file
+
+# 🌐 Eero API
+
+> Your async Python toolkit for Eero mesh networks ✨
+
+[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
+
+## ⚡ Why Eero API?
+
+- 🚀 **Async-first** — Non-blocking, blazing fast
+- 🔐 **Secure** — System keyring for credentials
+- 📦 **Type-safe** — Full Pydantic models
+- ⚡ **Smart caching** — Snappy responses
+
+## 📦 Install
+
+```bash
+pip install eero-api
+```
+
+## 🚀 Quick Start
+
+```python
+import asyncio
+from eero import EeroClient
+
+async def main():
+    async with EeroClient() as client:
+        if not client.is_authenticated:
+            await client.login("you@example.com")
+            await client.verify(input("Code: "))
+        
+        for network in await client.get_networks():
+            print(f"📶 {network.name}: {network.status}")
+
+asyncio.run(main())
+```
+
+> 💡 Credentials are auto-saved to your system keyring
+
+## 📚 Docs
+
+| Guide | What's inside |
+|-------|---------------|
+| **[📖 Python API](../../wiki/Python-API)** | Full API reference |
+| **[⚙️ Configuration](../../wiki/Configuration)** | Auth & settings |
+| **[🔧 Troubleshooting](../../wiki/Troubleshooting)** | Common fixes |
+| **[🏠 Wiki Home](../../wiki)** | All documentation |
+
+## 🔗 Ecosystem
+
+| Project | Description |
+|---------|-------------|
+| **[🖥️ eero-cli](https://github.com/fulviofreitas/eero-cli)** | Terminal interface for Eero networks |
+| **[🛜 eero-ui](https://github.com/fulviofreitas/eero-ui)** | Svelte dashboard for network management |
+| **[📊 eero-prometheus-exporter](https://github.com/fulviofreitas/eero-prometheus-exporter)** | Prometheus metrics for monitoring |
+
+## 📄 License
+
+[MIT](LICENSE) — Use it, fork it, build cool stuff 🎉

eero_api-1.2.4/README.md

@@ -0,0 +1,60 @@
+# 🌐 Eero API
+
+> Your async Python toolkit for Eero mesh networks ✨
+
+[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
+
+## ⚡ Why Eero API?
+
+- 🚀 **Async-first** — Non-blocking, blazing fast
+- 🔐 **Secure** — System keyring for credentials
+- 📦 **Type-safe** — Full Pydantic models
+- ⚡ **Smart caching** — Snappy responses
+
+## 📦 Install
+
+```bash
+pip install eero-api
+```
+
+## 🚀 Quick Start
+
+```python
+import asyncio
+from eero import EeroClient
+
+async def main():
+    async with EeroClient() as client:
+        if not client.is_authenticated:
+            await client.login("you@example.com")
+            await client.verify(input("Code: "))
+        
+        for network in await client.get_networks():
+            print(f"📶 {network.name}: {network.status}")
+
+asyncio.run(main())
+```
+
+> 💡 Credentials are auto-saved to your system keyring
+
+## 📚 Docs
+
+| Guide | What's inside |
+|-------|---------------|
+| **[📖 Python API](../../wiki/Python-API)** | Full API reference |
+| **[⚙️ Configuration](../../wiki/Configuration)** | Auth & settings |
+| **[🔧 Troubleshooting](../../wiki/Troubleshooting)** | Common fixes |
+| **[🏠 Wiki Home](../../wiki)** | All documentation |
+
+## 🔗 Ecosystem
+
+| Project | Description |
+|---------|-------------|
+| **[🖥️ eero-cli](https://github.com/fulviofreitas/eero-cli)** | Terminal interface for Eero networks |
+| **[🛜 eero-ui](https://github.com/fulviofreitas/eero-ui)** | Svelte dashboard for network management |
+| **[📊 eero-prometheus-exporter](https://github.com/fulviofreitas/eero-prometheus-exporter)** | Prometheus metrics for monitoring |
+
+## 📄 License
+
+[MIT](LICENSE) — Use it, fork it, build cool stuff 🎉

eero_api-1.2.4/pyproject.toml

@@ -0,0 +1,137 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "eero-api"
+version = "1.2.4"
+description = "Modern async Python client for Eero network management"
+readme = "README.md"
+requires-python = ">=3.12"
+license = {text = "MIT"}
+authors = [
+    {name = "Eero API Contributors"},
+]
+maintainers = [
+    {name = "Eero API Contributors"},
+]
+keywords = [
+    "eero",
+    "mesh-wifi",
+    "wifi",
+    "network",
+    "async",
+    "asyncio",
+    "home-automation",
+    "smart-home",
+    "api-client",
+    "iot",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Intended Audience :: System Administrators",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Home Automation",
+    "Topic :: Internet",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: System :: Networking",
+    "Typing :: Typed",
+    "Framework :: AsyncIO",
+]
+dependencies = [
+    "aiohttp>=3.8.0",
+    "pydantic>=2.0.0",
+    "keyring>=23.0.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0.0",
+    "pytest-asyncio>=0.21.0",
+    "pytest-cov>=4.0.0",
+    "black>=23.0.0",
+    "isort>=5.12.0",
+    "mypy>=1.0.0",
+    "ruff>=0.1.0",
+    # Testing dependencies
+    "rich>=13.0.0",
+    "click>=8.0.0",
+    # Optional: for interactive commit messages (cz commit)
+    "commitizen>=3.0.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/fulviofreitas/eero-api"
+Documentation = "https://github.com/fulviofreitas/eero-api/wiki"
+Repository = "https://github.com/fulviofreitas/eero-api"
+Changelog = "https://github.com/fulviofreitas/eero-api/blob/master/CHANGELOG.md"
+Issues = "https://github.com/fulviofreitas/eero-api/issues"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+eero = ["py.typed"]
+
+[tool.black]
+line-length = 100
+target-version = ["py312"]
+
+[tool.isort]
+profile = "black"
+line_length = 100
+
+[tool.mypy]
+python_version = "3.12"
+warn_return_any = false
+warn_unused_configs = true
+ignore_missing_imports = true
+check_untyped_defs = false
+disallow_untyped_defs = false
+no_implicit_optional = false
+
+[tool.ruff]
+line-length = 100
+target-version = "py312"
+
+[tool.ruff.lint]
+select = ["E", "F", "B", "W", "I"]
+ignore = [
+    "E501",  # Line too long - handled by black
+    "B904",  # raise-without-from-inside-except - existing code pattern
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+asyncio_mode = "auto"
+
+# ===========================================================================
+# Commitizen Configuration (for interactive commit messages)
+# ===========================================================================
+# Usage: cz commit
+# This provides a guided interface for creating Conventional Commits
+# ===========================================================================
+
+[tool.commitizen]
+name = "cz_conventional_commits"
+version = "1.2.4"
+version_files = [
+    "pyproject.toml:project.version",
+    "src/eero/__init__.py:__version__",
+]
+tag_format = "v$version"
+style = [
+    ["qmark", "fg:#ff9d00 bold"],
+    ["question", "bold"],
+    ["answer", "fg:#ff9d00 bold"],
+    ["pointer", "fg:#ff9d00 bold"],
+    ["highlighted", "fg:#ff9d00 bold"],
+    ["selected", "fg:#cc5454"],
+]

eero_api-1.2.4/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

eero_api-1.2.4/setup.py

@@ -0,0 +1,4 @@
+"""Backwards compatibility shim for pip install -e ."""
+from setuptools import setup
+
+setup()

eero_api-1.2.4/src/eero/__init__.py

@@ -0,0 +1,25 @@
+"""Eero API - Async Python client for Eero mesh WiFi networks."""
+
+from .api import EeroAPI
+from .client import EeroClient
+from .exceptions import (
+    EeroAPIException,
+    EeroAuthenticationException,
+    EeroException,
+    EeroNetworkException,
+    EeroRateLimitException,
+    EeroTimeoutException,
+)
+
+__all__ = [
+    "EeroAPI",
+    "EeroClient",
+    "EeroException",
+    "EeroAPIException",
+    "EeroAuthenticationException",
+    "EeroNetworkException",
+    "EeroRateLimitException",
+    "EeroTimeoutException",
+]
+
+__version__ = "1.2.4"

eero_api-1.2.4/src/eero/__main__.py

@@ -0,0 +1,6 @@
+"""Command-line entry point for the Eero API package."""
+
+from .cli.main import cli
+
+if __name__ == "__main__":
+    cli()

eero_api-1.2.4/src/eero/api/__init__.py

@@ -0,0 +1,137 @@
+"""API module for Eero."""
+
+from typing import Optional
+
+from aiohttp import ClientSession
+
+from .ac_compat import ACCompatAPI
+from .activity import ActivityAPI
+from .auth import AuthAPI
+from .backup import BackupAPI
+from .blacklist import BlacklistAPI
+from .burst_reporters import BurstReportersAPI
+from .devices import DevicesAPI
+from .diagnostics import DiagnosticsAPI
+from .dns import DnsAPI
+from .eeros import EerosAPI
+from .forwards import ForwardsAPI
+from .insights import InsightsAPI
+from .networks import NetworksAPI
+from .ouicheck import OUICheckAPI
+from .password import PasswordAPI
+from .profiles import ProfilesAPI
+from .reservations import ReservationsAPI
+from .routing import RoutingAPI
+from .schedule import ScheduleAPI
+from .security import SecurityAPI
+from .settings import SettingsAPI
+from .sqm import SqmAPI
+from .support import SupportAPI
+from .thread import ThreadAPI
+from .transfer import TransferAPI
+from .updates import UpdatesAPI
+
+
+class EeroAPI:
+    """API client for interacting with the Eero API."""
+
+    def __init__(
+        self,
+        session: Optional[ClientSession] = None,
+        cookie_file: Optional[str] = None,
+        use_keyring: bool = True,
+    ) -> None:
+        """Initialize the EeroAPI.
+
+        Args:
+            session: Optional aiohttp ClientSession to use for requests
+            cookie_file: Optional path to a file for storing authentication cookies
+            use_keyring: Whether to use keyring for secure token storage
+        """
+        self.auth = AuthAPI(session, cookie_file, use_keyring)
+        self.activity = ActivityAPI(self.auth)
+        self.backup = BackupAPI(self.auth)
+        self.dns = DnsAPI(self.auth)
+        self.networks = NetworksAPI(self.auth)
+        self.devices = DevicesAPI(self.auth)
+        self.eeros = EerosAPI(self.auth)
+        self.profiles = ProfilesAPI(self.auth)
+        self.schedule = ScheduleAPI(self.auth)
+        self.security = SecurityAPI(self.auth)
+        self.sqm = SqmAPI(self.auth)
+        self.diagnostics = DiagnosticsAPI(self.auth)
+        self.settings = SettingsAPI(self.auth)
+        self.updates = UpdatesAPI(self.auth)
+        self.insights = InsightsAPI(self.auth)
+        self.routing = RoutingAPI(self.auth)
+        self.thread = ThreadAPI(self.auth)
+        self.support = SupportAPI(self.auth)
+        self.blacklist = BlacklistAPI(self.auth)
+        self.reservations = ReservationsAPI(self.auth)
+        self.forwards = ForwardsAPI(self.auth)
+        self.transfer = TransferAPI(self.auth)
+        self.burst_reporters = BurstReportersAPI(self.auth)
+        self.ac_compat = ACCompatAPI(self.auth)
+        self.ouicheck = OUICheckAPI(self.auth)
+        self.password = PasswordAPI(self.auth)
+
+    async def __aenter__(self) -> "EeroAPI":
+        """Enter async context manager."""
+        await self.auth.__aenter__()
+        return self
+
+    async def __aexit__(self, exc_type, exc_val, exc_tb) -> None:
+        """Exit async context manager."""
+        await self.auth.__aexit__(exc_type, exc_val, exc_tb)
+
+    @property
+    def is_authenticated(self) -> bool:
+        """Check if the client is authenticated."""
+        return self.auth.is_authenticated
+
+    async def login(self, user_identifier: str) -> bool:
+        """Start the login process by requesting a verification code.
+
+        Args:
+            user_identifier: Email address or phone number for the Eero account
+
+        Returns:
+            True if login request was successful
+        """
+        return await self.auth.login(user_identifier)
+
+    async def verify(self, verification_code: str) -> bool:
+        """Verify login with the code sent to the user.
+
+        Args:
+            verification_code: The verification code sent to the user
+
+        Returns:
+            True if verification was successful
+        """
+        return await self.auth.verify(verification_code)
+
+    async def logout(self) -> bool:
+        """Log out from the Eero API.
+
+        Returns:
+            True if logout was successful
+        """
+        return await self.auth.logout()
+
+    def set_preferred_network(self, network_id: str) -> None:
+        """Set the preferred network ID to use for requests.
+
+        Args:
+            network_id: ID of the network to use
+        """
+        self.auth.preferred_network_id = network_id
+
+    @property
+    def preferred_network_id(self) -> Optional[str]:
+        """Get the preferred network ID.
+
+        Returns:
+            Preferred network ID or None
+        """
+        return self.auth.preferred_network_id

eero_api-1.2.4/src/eero/api/ac_compat.py

@@ -0,0 +1,49 @@
+"""AC Compatibility API for Eero."""
+
+import logging
+from typing import Any, Dict
+
+from ..const import API_ENDPOINT
+from ..exceptions import EeroAuthenticationException
+from .auth import AuthAPI
+from .base import AuthenticatedAPI
+
+_LOGGER = logging.getLogger(__name__)
+
+
+class ACCompatAPI(AuthenticatedAPI):
+    """AC Compatibility API for Eero."""
+
+    def __init__(self, auth_api: AuthAPI) -> None:
+        """Initialize the ACCompatAPI.
+
+        Args:
+            auth_api: Authentication API instance
+        """
+        super().__init__(auth_api, API_ENDPOINT)
+
+    async def get_ac_compat(self, network_id: str) -> Dict[str, Any]:
+        """Get AC compatibility information.
+
+        Args:
+            network_id: ID of the network to get AC compatibility info for
+
+        Returns:
+            AC compatibility data
+
+        Raises:
+            EeroAuthenticationException: If not authenticated
+            EeroAPIException: If the API returns an error
+        """
+        auth_token = await self._auth_api.get_auth_token()
+        if not auth_token:
+            raise EeroAuthenticationException("Not authenticated")
+
+        _LOGGER.debug(f"Getting AC compatibility for network {network_id}")
+
+        response = await self.get(
+            f"networks/{network_id}/ac_compat",
+            auth_token=auth_token,
+        )
+
+        return response.get("data", {})