Merge pull request 'chore: adopt the NAPALM driver standard' (#5) 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

@@ -1,3 +1,10 @@
 __pycache__/
 *.pyc
 *.egg-info/
+.venv/
+build/
+dist/
+.coverage
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/

CHANGELOG.md

@@ -0,0 +1,21 @@
+# 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.2.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 is now licensed under
+  Apache-2.0 and ships a LICENSE file, a README and `py.typed`. It needs
+  napalm-device-types 4.21.1 or later.
+- A failed logout and an unreadable system info in `get_facts()` are now logged at
+  debug level.

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,55 @@
+# napalm-yealink
+
+NAPALM driver for Yealink IP phones and video endpoints (T, W, CP and VP series), built on
+[napalm-device-types](https://git.netork.io/NAPALM/napalm-device-types) (`PhoneDriver`).
+
+## Tested against
+
+| Model | Firmware |
+|---|---|
+| not recorded yet | not recorded yet |
+
+## Connection
+
+The phone's REST API under `/api/v1/` over HTTPS on port 443. `open()` logs in at
+`/api/v1/session/login` with the username and the MD5 hex digest of the password (the
+driver computes it) and keeps the session cookie. A refused login does not fail `open()`:
+even without a session, `/api/v1/system/info` names the model and firmware.
+
+```python
+from napalm import get_network_driver
+
+driver = get_network_driver("yealink")
+with driver("192.0.2.20", "admin", "secret") as device:
+    print(device.get_facts())
+```
+
+| Optional argument | Default | Meaning |
+|---|---|---|
+| `verify_ssl` | `False` | verify the phone's TLS certificate |
+
+## Supported
+
+| Getter / action | |
+|---|---|
+| `get_facts` | model, firmware, hostname, serial number from `/api/v1/system/info` |
+| `is_alive` | TCP connect to port 443 |
+
+## Not supported
+
+Everything else a NAPALM driver can offer — interfaces, configuration, LLDP, ARP, MAC
+table, NTP, SNMP, users, routes, `ping` and the CLI — raises `NotImplementedError`.
+`get_facts` reports no uptime and no interfaces.
+
+## 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_yealink/yealink.py

@@ -14,14 +14,16 @@ automatically) or via ``optional_args={"verify_ssl": False}``.
 from __future__ import annotations
 
 import hashlib
+import logging
 import socket
 from typing import Any
 
 import requests
+from napalm.base.exceptions import ConnectionException
+from napalm_device_types import FingerprintRule, PhoneDriver
 from requests.exceptions import RequestException
 
-from napalm.base.exceptions import ConnectionClosedException, ConnectionException
-from napalm_device_types import FingerprintRule, PhoneDriver
+logger = logging.getLogger(__name__)
 
 
 class YealinkDriver(PhoneDriver):
@@ -36,7 +38,8 @@ class YealinkDriver(PhoneDriver):
         "80:5E:0C",  # YEALINK(XIAMEN) NETWORK TECHNOLOGY — IEEE, verifiziert an T58V
     ]
     HTTP_FINGERPRINT = [
-        FingerprintRule("yealink", weight=10.0),  # nicht mandatory: Yealink/api redirect hat kein "yealink" im Body
+        # Not mandatory: the redirect of some models to their API page has no "yealink" in it.
+        FingerprintRule("yealink", weight=10.0),
         FingerprintRule("sip-t", weight=5.0),
         FingerprintRule("sip-w", weight=5.0),
         FingerprintRule("sip-cp", weight=5.0),
@@ -69,7 +72,9 @@ class YealinkDriver(PhoneDriver):
     def open(self) -> None:
         self._session = requests.Session()
         self._session.verify = self._verify_ssl
-        pw_hash = hashlib.md5(self.password.encode()).hexdigest()
+        # The login API takes the password as an MD5 hex digest: the wire format, not a
+        # protection (the session runs over HTTPS).
+        pw_hash = hashlib.md5(self.password.encode(), usedforsecurity=False).hexdigest()
         try:
             resp = self._session.post(
                 f"{self._base_url}{self._LOGIN_PATH}",
@@ -91,7 +96,7 @@ class YealinkDriver(PhoneDriver):
                     timeout=5,
                 )
             except Exception:
-                pass
+                logger.debug("Logging out of the phone failed: ignored", exc_info=True)
             self._session.close()
             self._session = None
 
@@ -122,7 +127,7 @@ class YealinkDriver(PhoneDriver):
             payload = data.get("data") or data.get("error") or {}
             info = payload if isinstance(payload, dict) else {}
         except Exception:
-            pass
+            logger.debug("Reading the system info failed: ignored", exc_info=True)
 
         model = info.get("phoneName") or info.get("model") or "Yealink"
         firmware = info.get("firmware") or info.get("firmwareVersion") or ""
@@ -144,7 +149,9 @@ class YealinkDriver(PhoneDriver):
     def get_interfaces(self) -> dict:
         raise NotImplementedError
 
-    def get_config(self, retrieve: str = "all", full: bool = False, sanitized: bool = False) -> dict:
+    def get_config(
+        self, retrieve: str = "all", full: bool = False, sanitized: bool = False
+    ) -> dict:
         raise NotImplementedError
 
     def get_interfaces_ip(self) -> dict:
@@ -192,7 +199,9 @@ class YealinkDriver(PhoneDriver):
     def cli(self, commands: list[str], encoding: str = "text") -> dict:
         raise NotImplementedError
 
-    def load_replace_candidate(self, filename: str | None = None, config: str | None = None) -> None:
+    def load_replace_candidate(
+        self, filename: str | None = None, config: str | None = None
+    ) -> None:
         raise NotImplementedError
 
     def load_merge_candidate(self, filename: str | None = None, config: str | None = None) -> None:

pyproject.toml

@@ -1,24 +1,80 @@
 [build-system]
-requires = ["setuptools>=61"]
+requires = ["setuptools>=77"]
 build-backend = "setuptools.build_meta"
 
 [project]
 name = "napalm-yealink"
-version = "0.1.1"
+version = "0.2.0"
 description = "NAPALM driver for Yealink IP phones and video endpoints"
+readme = "README.md"
+license = "Apache-2.0"
 requires-python = ">=3.10"
+authors = [
+    { name = "Christian Manivong" },
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: System :: Networking",
+]
 dependencies = [
-    "napalm",
-    "napalm-device-types",
-    "requests",
+    "napalm>=4.0",
+    "napalm-device-types>=4.21.1",
+    "requests>=2.28.0",
 ]
 
 [project.optional-dependencies]
-dev = ["pytest"]
+dev = ["pytest>=8", "pytest-cov>=5", "mypy>=1.11", "ruff>=0.6"]
 
 [project.entry-points."napalm.drivers"]
 yealink = "napalm_yealink:YealinkDriver"
 
+[project.urls]
+Repository = "https://git.netork.io/NAPALM/napalm-yealink"
+Issues = "https://git.netork.io/NAPALM/napalm-yealink/issues"
+Changelog = "https://git.netork.io/NAPALM/napalm-yealink/src/branch/main/CHANGELOG.md"
+
 [tool.setuptools.packages.find]
 where = ["."]
 include = ["napalm_yealink*"]
+
+[tool.setuptools.package-data]
+napalm_yealink = ["py.typed"]
+
+[tool.ruff]
+line-length = 100
+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_yealink.yealink"]
+ignore_errors = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.coverage.run]
+source = ["napalm_yealink"]
+
+[tool.coverage.report]
+fail_under = 42

tests/quality_baseline.json

@@ -0,0 +1,12 @@
+{
+ "coverage_floor": 42.0,
+ "function_complexity": {
+  "napalm_yealink/yealink.py::YealinkDriver.get_facts": 12
+ },
+ "function_lines": {},
+ "mypy_relaxed": [
+  "napalm_yealink.yealink"
+ ],
+ "python_file_lines": {},
+ "untyped_public": []
+}

tests/test_capabilities.py

@@ -9,6 +9,8 @@ import pytest
 from napalm_yealink.yealink import YealinkDriver
 
 
-@pytest.mark.parametrize("name", ["get_health_metrics", "get_ssids", "get_radio_info", "get_wireless_clients"])
+@pytest.mark.parametrize(
+    "name", ["get_health_metrics", "get_ssids", "get_radio_info", "get_wireless_clients"]
+)
 def test_no_stub_claims_what_the_phone_cannot_do(name):
     assert name not in vars(YealinkDriver)

tests/test_fingerprint.py

@@ -1,6 +1,7 @@
 """Fingerprint tests for YealinkDriver."""
 
 from napalm_device_types import DeviceTypeDriver, PhoneDriver, role_keys_of
+
 from napalm_yealink import YealinkDriver