Merge pull request 'chore: adopt the NAPALM driver standard' (#9) from chore/driver-standard into main

.gitea/workflows/ci.yml

@@ -0,0 +1,15 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+    tags: ["v*"]
+  pull_request:
+
+jobs:
+  driver:
+    uses: NAPALM/driver-standard/.gitea/workflows/driver.yml@main
+    with:
+      standard-ref: main
+    secrets:
+      PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}

.github/workflows/ci.yml

@@ -1,48 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches: ["**"]
-  pull_request:
-    branches: ["**"]
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        python-version: ["3.10", "3.11", "3.12"]
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Setup Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: ${{ matrix.python-version }}
-          cache: pip
-
-      - name: Install package with dev extras
-        run: |
-          python -m pip install --upgrade pip
-          # napalm-device-types lives in git.netork.io/NAPALM, not on PyPI: without this
-          # pip looks there, finds an unrelated 0.1.0 and the job dies before any test.
-          python -m pip install "napalm-device-types @ git+https://git.netork.io/NAPALM/napalm-device-types.git"
-          python -m pip install -e ".[dev]"
-
-      - name: Run unit tests
-        run: |
-          python -m pytest -q --tb=short
-
-      - name: Build wheel and sdist
-        run: |
-          python -m pip install build
-          python -m build
-
-      - name: Upload dist artifacts
-        # v4 refuses to run on Gitea ("not currently supported on GHES").
-        uses: actions/upload-artifact@v3
-        with:
-          name: dist-${{ matrix.python-version }}
-          path: dist/*

.gitignore

@@ -2,3 +2,8 @@
 __pycache__/
 *.egg-info/
 .pytest_cache/
+build/
+dist/
+.coverage
+.mypy_cache/
+.ruff_cache/

CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+All notable changes to this driver. The format follows
+[Keep a Changelog](https://keepachangelog.com/), versions follow
+[Semantic Versioning](https://semver.org/).
+
+## [Unreleased]
+
+## [0.3.0] - 2026-10-23
+
+The first release on PyPI.
+
+### Changed
+- The driver follows the NAPALM driver standard
+  (https://git.netork.io/NAPALM/driver-standard): CI on Gitea runs ruff, mypy, the
+  tests on Python 3.10–3.13 and at the lowest declared versions, bandit, pip-audit and
+  a build check, and a release tag publishes to PyPI. The package now ships `py.typed`,
+  a README and a LICENSE file. **Python 3.9 is no longer supported**; napalm-device-types
+  never ran on it. It needs napalm-device-types 4.21.1 or later.
+- A failed login keeps the underlying error as the cause of the `ConnectionException`.

LICENSE

@@ -0,0 +1,191 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship made available under
+      the License, as indicated by a copyright notice that is included in
+      or attached to the work (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other transformations
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean, as submitted to the Licensor for inclusion
+      in the Work by the copyright owner or by an individual or Legal Entity
+      authorized to submit on behalf of the copyright owner. For the purposes
+      of this definition, "submitted" means any form of electronic, verbal,
+      or written communication sent to the Licensor or its representatives,
+      including but not limited to communication on electronic mailing lists,
+      source code control systems, and issue tracking systems that are managed
+      by, or on behalf of, the Licensor for the purpose of discussing and
+      improving the Work, but excluding communication that is conspicuously
+      marked or designated in writing by the copyright owner as "Not a
+      Contribution."
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and incorporated
+      within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by the combined Contribution(s) and the Work
+      to which such Contribution(s) was submitted. If You institute patent
+      litigation against any entity (including a cross-claim or counterclaim
+      in a lawsuit) alleging that the Work or any Contribution embodied
+      within the Work constitutes direct or contributory patent infringement,
+      then any patent licenses granted to You under this License for that
+      Work shall terminate as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, You must include a readable copy of the
+          attribution notices contained within such NOTICE file, in
+          at least one of the following places: within a NOTICE text file
+          distributed as part of the Derivative Works; within the Source
+          form or documentation, if provided along with the Derivative
+          Works; or, within a display generated by the Derivative Works,
+          if and wherever such third-party notices normally appear. The
+          contents of the NOTICE file are for informational purposes only
+          and do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own license statement for Your modifications and
+      may provide additional grant of rights to use, copy, modify, merge,
+      publish, distribute, sublicense, and/or sell copies of the Work,
+      and to permit persons to whom the Work is furnished to do so,
+      subject to the following conditions:
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any conditions of TITLE,
+      MERCHANTIBILITY, or FITNESS FOR A PARTICULAR PURPOSE.
+      See the License for the specific language governing permissions and
+      limitations under the License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or exemplary damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (even if such Contributor has been advised of the possibility
+      of such damages).
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may offer only
+      conditions consistent with this License, subject to the following
+      additional conditions:
+
+      (a) You may offer additional warranty, indemnity, or other liability
+          terms and conditions; and
+
+      (b) You may offer support for the Work in return for a fee.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format in question. It may also be
+      possible to make it available with a creative commons license.
+
+   Copyright 2026 Christian Manivong
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.md

@@ -0,0 +1,68 @@
+# napalm-zyxel
+
+NAPALM driver for Zyxel VMG series residential gateways (VMG4005-B50A and similar), built on
+[napalm-device-types](https://git.netork.io/NAPALM/napalm-device-types)
+(`ResidentialGatewayDriver`).
+
+## Tested against
+
+| Model | Firmware |
+|---|---|
+| not recorded yet | not recorded yet |
+
+## Connection
+
+The gateway's web API (the Zyxel DAL protocol) over HTTP on port 80, or HTTPS on port 443
+with `use_tls`. The driver fetches the gateway's RSA public key, sends a fresh AES key
+encrypted with it, and logs in with the web interface account; every request and response
+after that is AES-encrypted.
+
+```python
+from napalm import get_network_driver
+
+driver = get_network_driver("zyxel")
+with driver("192.0.2.1", "admin", "secret", optional_args={"use_tls": True}) as device:
+    print(device.get_facts())
+```
+
+| Optional argument | Default | Meaning |
+|---|---|---|
+| `use_tls` | `False` | HTTPS instead of HTTP |
+| `port` | `443` with `use_tls`, else `80` | port of the web interface |
+| `verify` | `False` | verify the gateway's TLS certificate |
+
+## Supported
+
+| Getter / action | Source |
+|---|---|
+| `get_facts` | basic device information |
+| `get_interfaces`, `get_interfaces_ip` | basic device information (WAN, LAN, Wi-Fi) |
+| `get_arp_table` | derived from the active LAN hosts |
+| `get_wan_status` | basic device information |
+| `get_hosts` | DAL `LAN_HOSTS`, else the DHCP page |
+| `get_port_forwards`, `get_nat_translations` | DAL `NAT_PORTMAP`, else the status page |
+| `get_wireless_clients`, `get_ssids`, `get_radio_status` | DAL, else the wireless page |
+| `get_diagnostics` | DAL `DIAGNOSTICS` |
+| `ping` | DAL `PINGTEST` |
+| `is_alive` | TCP connect to the web port |
+| `reboot_host` | DAL `REBOOT` |
+| `restart_wifi` | DAL `WIFI_RESTART` |
+
+## Not supported
+
+Configuration changes (`load_merge_candidate` and `load_replace_candidate` raise
+`NotImplementedError`), `get_config`, LLDP, BGP, NTP, SNMP, users, routes, MAC address
+table, optics, environment, traceroute, VPN tunnels and the CLI.
+
+## Development
+
+The rules are in [STANDARDS.md](https://git.netork.io/NAPALM/driver-standard/src/branch/main/STANDARDS.md).
+
+```bash
+python -m venv .venv && .venv/bin/pip install -e ".[dev]"
+.venv/bin/pytest --cov
+```
+
+## License
+
+Apache-2.0

napalm_zyxel/zyxel_driver.py

@@ -15,13 +15,12 @@ from typing import Any
 from urllib.parse import urljoin
 
 import requests
-from cryptography.hazmat.primitives import serialization
-from cryptography.hazmat.primitives.asymmetric import padding as asym_padding, rsa
-from cryptography.hazmat.primitives.ciphers import Cipher, algorithms, modes
 from cryptography.hazmat.backends import default_backend
-
+from cryptography.hazmat.primitives import serialization
+from cryptography.hazmat.primitives.asymmetric import padding as asym_padding
+from cryptography.hazmat.primitives.asymmetric import rsa
+from cryptography.hazmat.primitives.ciphers import Cipher, algorithms, modes
 from napalm.base.exceptions import ConnectionClosedException, ConnectionException
-
 from napalm_device_types import FingerprintRule, ResidentialGatewayDriver
 from napalm_device_types.models import (
     HostDict,
@@ -75,7 +74,9 @@ class ZyxelCrypto:
 
     def encrypt_aes_key_with_rsa(self, pubkey_pem: str) -> str:
         """Encrypt the AES key with the device's RSA public key for key exchange."""
-        pubkey = serialization.load_pem_public_key(pubkey_pem.encode("ascii"), backend=default_backend())
+        pubkey = serialization.load_pem_public_key(
+            pubkey_pem.encode("ascii"), backend=default_backend()
+        )
         if not isinstance(pubkey, rsa.RSAPublicKey):
             raise ValueError("Not an RSA public key")
         encrypted = pubkey.encrypt(
@@ -127,9 +128,7 @@ class ZyxelVMGDriver(ResidentialGatewayDriver):
         self._session: requests.Session | None = None
         self._sessionkey: str | None = None
         self._crypto: ZyxelCrypto | None = None
-        self._base_url: str = (
-            f"{'https' if self.use_tls else 'http'}://{self.hostname}:{self.port}"
-        )
+        self._base_url: str = f"{'https' if self.use_tls else 'http'}://{self.hostname}:{self.port}"
 
     def _url(self, path: str) -> str:
         return urljoin(f"{self._base_url}/", path)
@@ -143,26 +142,21 @@ class ZyxelVMGDriver(ResidentialGatewayDriver):
 
         info = self._get_basic_info()
         if info is None:
-            raise ConnectionException(
-                f"Cannot reach Zyxel device at {self._base_url}"
-            )
+            raise ConnectionException(f"Cannot reach Zyxel device at {self._base_url}")
         self._device_info = info
 
         crypto = ZyxelCrypto()
         pubkey = self._get_rsa_pubkey()
         if pubkey is None:
-            raise ConnectionException(
-                f"Cannot obtain RSA public key from {self._base_url}"
-            )
+            raise ConnectionException(f"Cannot obtain RSA public key from {self._base_url}")
         enc_key = crypto.encrypt_aes_key_with_rsa(pubkey)
 
         login_data = {
             "Input_Account": self.username,
-            "Input_Passwd": base64.b64encode(
-                self.password.encode("ascii")
-            ).decode("ascii"),
+            "Input_Passwd": base64.b64encode(self.password.encode("ascii")).decode("ascii"),
             "RememberPassword": 0,
-            "SHA512_password": False,
+            # A flag telling the gateway how Input_Passwd is encoded, not a password.
+            "SHA512_password": False,  # nosec B105
         }
 
         enc_payload = crypto.encrypt_json(login_data)
@@ -176,7 +170,7 @@ class ZyxelVMGDriver(ResidentialGatewayDriver):
             resp.raise_for_status()
             result = crypto.decrypt_response(resp.json())
         except (requests.RequestException, json.JSONDecodeError, TypeError, KeyError) as e:
-            raise ConnectionException(f"Login failed at {self._base_url}: {e}")
+            raise ConnectionException(f"Login failed at {self._base_url}: {e}") from e
 
         if result.get("result") != "ZCFG_SUCCESS":
             raise ConnectionException(
@@ -332,12 +326,14 @@ class ZyxelVMGDriver(ResidentialGatewayDriver):
         for host in self.get_hosts():
             if not host["is_active"] or not host["mac"] or not host["ip"]:
                 continue
-            arp.append({
+            arp.append(
+                {
                     "interface": host["interface_type"],
                     "mac": host["mac"],
                     "ip": host["ip"],
                     "age": 0.0,
-            })
+                }
+            )
         return arp
 
     def get_lldp_neighbors(self) -> dict[str, Any]:
@@ -390,14 +386,17 @@ class ZyxelVMGDriver(ResidentialGatewayDriver):
         source_interface: str = "",
     ) -> dict[str, Any]:
         """Ping a destination via the device's DAL diagnostics."""
-        result = self._dal_query("PINGTEST", {
+        result = self._dal_query(
+            "PINGTEST",
+            {
                 "ProtocolVersion": "IPv4",
                 "Host": destination,
                 "DiagnosticsState": "Requested",
                 "DNSServer": "",
                 "NumberOfRepetitions": count,
                 "type": 0,
-        })
+            },
+        )
         if result is None:
             return {"success": {}, "error": "Ping not supported via DAL"}
         return {
@@ -487,9 +486,7 @@ class ZyxelVMGDriver(ResidentialGatewayDriver):
         """Not supported on Zyxel VMG."""
         raise NotImplementedError("Zyxel VMG does not support config replacement via NAPALM")
 
-    def load_merge_candidate(
-        self, filename: str | None = None, config: str | None = None
-    ) -> None:
+    def load_merge_candidate(self, filename: str | None = None, config: str | None = None) -> None:
         """Not supported on Zyxel VMG."""
         raise NotImplementedError("Zyxel VMG does not support config merge via NAPALM")
 
@@ -562,14 +559,16 @@ class ZyxelVMGDriver(ResidentialGatewayDriver):
     def _parse_port_forwards_html(self, html: str) -> list[PortForwardDict]:
         forwards: list[PortForwardDict] = []
         for match in self._PORT_FORWARD_RE.finditer(html):
-            forwards.append({
+            forwards.append(
+                {
                     "name": match.group("name").strip(),
                     "protocol": match.group("proto").upper(),
                     "external_port": int(match.group("ext_port")),
                     "internal_ip": match.group("int_ip"),
                     "internal_port": int(match.group("int_port")),
                     "enabled": True,
-            })
+                }
+            )
         return forwards
 
     def get_hosts(self) -> list[HostDict]:
@@ -620,13 +619,15 @@ class ZyxelVMGDriver(ResidentialGatewayDriver):
     def _parse_hosts_html(self, html: str) -> list[HostDict]:
         hosts: list[HostDict] = []
         for match in self._HOST_RE.finditer(html):
-            hosts.append({
+            hosts.append(
+                {
                     "mac": match.group("mac").lower(),
                     "ip": match.group("ip"),
                     "hostname": match.group("hostname") or "",
                     "interface_type": "lan",
                     "is_active": True,
-            })
+                }
+            )
         return hosts
 
     def get_nat_translations(self) -> list[NATTranslationDict]:
@@ -636,14 +637,16 @@ class ZyxelVMGDriver(ResidentialGatewayDriver):
         for forward in self.get_port_forwards():
             if not forward["enabled"]:
                 continue
-            translations.append({
+            translations.append(
+                {
                     "protocol": forward["protocol"].lower(),
                     "inside_local": f"{forward['internal_ip']}:{forward['internal_port']}",
                     "inside_global": f"{wan_ip}:{forward['external_port']}",
                     "outside_local": "0.0.0.0:0",
                     "outside_global": "0.0.0.0:0",
                     "age": 0.0,
-            })
+                }
+            )
         return translations
 
     def get_vpn_tunnels(self) -> dict[str, VPNTunnelDict]:
@@ -701,7 +704,8 @@ class ZyxelVMGDriver(ResidentialGatewayDriver):
     def _parse_wireless_clients_html(self, html: str) -> list[WirelessClientDict]:
         clients: list[WirelessClientDict] = []
         for match in self._WIFI_CLIENT_RE.finditer(html):
-            clients.append({
+            clients.append(
+                {
                     "mac": match.group("mac").lower(),
                     "ssid": "",
                     "radio": "wlan0",
@@ -711,7 +715,8 @@ class ZyxelVMGDriver(ResidentialGatewayDriver):
                     "rx_rate": 0.0,
                     "uptime": 0,
                     "ip": match.group("ip"),
-            })
+                }
+            )
         return clients
 
     def get_ssids(self) -> dict[str, SSIDDict]:
@@ -784,7 +789,9 @@ class ZyxelVMGDriver(ResidentialGatewayDriver):
                         "enabled": bool(entry.get("Enabled", entry.get("enabled", True))),
                         "band": "2.4GHz" if channel <= 14 else "5GHz",
                         "channel": channel,
-                        "channel_width": int(entry.get("ChannelWidth", entry.get("channel_width", 0)) or 0),
+                        "channel_width": int(
+                            entry.get("ChannelWidth", entry.get("channel_width", 0)) or 0
+                        ),
                         "tx_power": int(entry.get("TxPower", entry.get("tx_power", 0)) or 0),
                         "frequency": float(entry.get("Frequency", entry.get("frequency", 0)) or 0),
                     }

pyproject.toml

@@ -1,55 +1,82 @@
 [build-system]
-requires = ["setuptools>=68", "wheel"]
+requires = ["setuptools>=77"]
 build-backend = "setuptools.build_meta"
 
 [project]
 name = "napalm-zyxel"
-version = "0.2.0"
+version = "0.3.0"
 description = "NAPALM driver for Zyxel VMG series residential gateways (VMG4005-B50A and similar)."
 readme = "README.md"
-license = { text = "Apache-2.0" }
-requires-python = ">=3.9"
+license = "Apache-2.0"
+requires-python = ">=3.10"
 authors = [
     { name = "Christian Manivong" },
 ]
 classifiers = [
     "Topic :: Utilities",
-    "License :: OSI Approved :: Apache Software License",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
     "Operating System :: POSIX :: Linux",
     "Operating System :: MacOS",
 ]
 dependencies = [
     "napalm>=4.0.0",
-    "napalm_device_types>=0.4.0",
+    "napalm-device-types>=4.21.1",
     "requests>=2.28.0",
 ]
 
 [project.optional-dependencies]
-dev = [
-    "pytest",
-    "pytest-cov",
-    "black",
-    "ruff",
-]
+dev = ["pytest>=8", "pytest-cov>=5", "mypy>=1.11", "ruff>=0.6"]
 
 [project.entry-points."napalm.drivers"]
 zyxel = "napalm_zyxel.zyxel_driver:ZyxelVMGDriver"
 
 [project.urls]
-Repository = "https://github.com/napalm-automation-community/napalm-zyxel"
+Repository = "https://git.netork.io/NAPALM/napalm-zyxel"
+Issues = "https://git.netork.io/NAPALM/napalm-zyxel/issues"
+Changelog = "https://git.netork.io/NAPALM/napalm-zyxel/src/branch/main/CHANGELOG.md"
 
 [tool.setuptools.packages.find]
 where = ["."]
 include = ["napalm_zyxel*"]
 
+[tool.setuptools.package-data]
+napalm_zyxel = ["py.typed"]
+
 [tool.ruff]
 line-length = 100
-target-version = "py39"
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B"]
+
+[tool.ruff.lint.per-file-ignores]
+# Recorded device output keeps its lines.
+"tests/**" = ["E501"]
+
+[tool.mypy]
+python_version = "3.10"
+strict = true
+# napalm itself is untyped, so every driver subclasses Any.
+disallow_subclassing_any = false
+
+[[tool.mypy.overrides]]
+module = ["napalm.*"]
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+# Not yet under strict mypy (quality baseline); may only shrink.
+module = ["napalm_zyxel.zyxel_driver"]
+ignore_errors = true
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]
+
+[tool.coverage.run]
+source = ["napalm_zyxel"]
+
+[tool.coverage.report]
+fail_under = 68

tests/quality_baseline.json

@@ -0,0 +1,13 @@
+{
+ "coverage_floor": 68.0,
+ "function_complexity": {
+  "napalm_zyxel/zyxel_driver.py::ZyxelVMGDriver._parse_wireless_clients_dal": 12,
+  "napalm_zyxel/zyxel_driver.py::ZyxelVMGDriver.get_radio_status": 14
+ },
+ "function_lines": {},
+ "mypy_relaxed": [
+  "napalm_zyxel.zyxel_driver"
+ ],
+ "python_file_lines": {},
+ "untyped_public": []
+}

tests/test_zyxel.py

@@ -3,12 +3,10 @@ from unittest.mock import MagicMock, patch
 
 import pytest
 import requests
-
 from napalm.base.exceptions import ConnectionException
 
 from napalm_zyxel import ZyxelVMGDriver
 
-
 MOCK_BASIC_INFO = {
     "ModelName": "VMG4005-B50A",
     "SoftwareVersion": "V5.13(ABKS.1)C0",
@@ -117,7 +115,8 @@ class TestZyxelVMGDriver:
             mock_crypto = MagicMock()
             mock_crypto.encrypt_json.return_value = {"content": "ENC", "iv": "IV", "key": ""}
             mock_crypto.decrypt_response.return_value = {
-                "result": "ZCFG_SUCCESS", "sessionkey": "12345"
+                "result": "ZCFG_SUCCESS",
+                "sessionkey": "12345",
             }
             mock_crypto.encrypt_aes_key_with_rsa.return_value = "ENC_KEY"
             mock_crypto_cls.return_value = mock_crypto
@@ -127,12 +126,8 @@ class TestZyxelVMGDriver:
             session.post.return_value = MockResponse(MOCK_LOGIN_RESPONSE)
 
             with patch.object(self.driver, "_session", session, create=False):
-                with patch.object(
-                    self.driver, "_get_rsa_pubkey", return_value=MOCK_RSA_KEY
-                ):
-                    with patch.object(
-                        self.driver, "_get_basic_info", return_value=MOCK_BASIC_INFO
-                    ):
+                with patch.object(self.driver, "_get_rsa_pubkey", return_value=MOCK_RSA_KEY):
+                    with patch.object(self.driver, "_get_basic_info", return_value=MOCK_BASIC_INFO):
                         self.driver._session = None
                         self.driver._crypto = None
                         self.driver._sessionkey = None
@@ -151,11 +146,8 @@ class TestZyxelVMGDriver:
                 sess = MagicMock()
                 sess.get.side_effect = requests.ConnectionError("unreachable")
                 mock_session.return_value = sess
-                try:
+                with pytest.raises(ConnectionException):
                     self.driver.open()
-                    assert False, "Expected ConnectionException"
-                except ConnectionException:
-                    pass
 
     def test_close(self):
         self._setup_mocked_http()
@@ -303,19 +295,13 @@ class TestZyxelVMGDriver:
 
     def test_load_replace_candidate_raises(self):
         self._setup_mocked_http()
-        try:
+        with pytest.raises(NotImplementedError):
             self.driver.load_replace_candidate()
-            assert False, "Expected NotImplementedError"
-        except NotImplementedError:
-            pass
 
     def test_load_merge_candidate_raises(self):
         self._setup_mocked_http()
-        try:
+        with pytest.raises(NotImplementedError):
             self.driver.load_merge_candidate()
-            assert False, "Expected NotImplementedError"
-        except NotImplementedError:
-            pass
 
     def test_ping_not_implemented(self):
         self._setup_mocked_http()
@@ -330,11 +316,8 @@ class TestZyxelVMGDriver:
         from napalm.base.exceptions import ConnectionClosedException
 
         self.driver._session = None
-        try:
+        with pytest.raises(ConnectionClosedException):
             self.driver._dal_query("PINGTEST", {})
-            assert False, "Expected ConnectionClosedException"
-        except ConnectionClosedException:
-            pass
 
     def test_parse_port_forwards_dal(self):
         self._setup_mocked_http()