From 06a39b49b36ce75f3f5b6dda67dff2c62ecedcbe Mon Sep 17 00:00:00 2001 From: Christian Manivong Date: Fri, 23 Oct 2026 08:41:56 +0200 Subject: [PATCH 1/3] style: ruff format and the lint rules of the driver standard The rule set every NAPALM driver uses (E, F, I, UP, B at line length 100, Python 3.10). The code already meets it: ruff format and ruff check --fix change nothing. --- pyproject.toml | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 04a24f5..b2901aa 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -53,4 +53,11 @@ include = ["napalm_hpe_officeconnect*"] [tool.ruff] line-length = 100 -target-version = "py38" +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"] From ed928c22b0595711882a78eea698d39f3a31722b Mon Sep 17 00:00:00 2001 From: Christian Manivong Date: Fri, 23 Oct 2026 08:44:17 +0200 Subject: [PATCH 2/3] chore: adopt the NAPALM driver standard - CI moves to .gitea/workflows/ci.yml and calls the shared driver workflow of NAPALM/driver-standard; .github/ goes. - requires-python >=3.10 (napalm-device-types needs it), CHANGELOG, py.typed, SPDX license string, Issues and Changelog links; a dev extra with floors. - napalm-device-types >=4.21.1 is declared: officeconnect.py imports SwitchDriver and FingerprintRule from it, but the package did not list it. - urllib3 gets a true floor (>=1.23): unbounded, the lowest job installed a version that does not import on Python 3.10. - mypy strict for the package; napalm_hpe_officeconnect.officeconnect is exempt for now (4 errors: three ClassVar fingerprint attributes the base declares as instance variables, one bare dict), recorded in the quality baseline. Coverage floor 91 % (measured 91.83 %). --- .gitea/workflows/ci.yml | 15 ++++++++++ .github/workflows/ci.yml | 48 ----------------------------- .gitignore | 1 + CHANGELOG.md | 25 ++++++++++++++++ napalm_hpe_officeconnect/py.typed | 0 pyproject.toml | 50 ++++++++++++++++++++++++------- tests/quality_baseline.json | 10 +++++++ 7 files changed, 90 insertions(+), 59 deletions(-) create mode 100644 .gitea/workflows/ci.yml delete mode 100644 .github/workflows/ci.yml create mode 100644 CHANGELOG.md create mode 100644 napalm_hpe_officeconnect/py.typed create mode 100644 tests/quality_baseline.json diff --git a/.gitea/workflows/ci.yml b/.gitea/workflows/ci.yml new file mode 100644 index 0000000..7530c79 --- /dev/null +++ b/.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 }} diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml deleted file mode 100644 index a7bc4d4..0000000 --- a/.github/workflows/ci.yml +++ /dev/null @@ -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/* \ No newline at end of file diff --git a/.gitignore b/.gitignore index e8045eb..14b55a5 100644 --- a/.gitignore +++ b/.gitignore @@ -9,3 +9,4 @@ venv/ .ruff_cache/ .coverage htmlcov/ +.mypy_cache/ diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..d6c9ab1 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,25 @@ +# Changelog + +All notable changes to this driver. The format follows +[Keep a Changelog](https://keepachangelog.com/), versions follow +[Semantic Versioning](https://semver.org/). + +## [Unreleased] + +### 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`. + **Python 3.8 and 3.9 are no longer supported**; napalm-device-types never ran on + them. +- napalm-device-types (4.21.1 or newer) is now a declared dependency; the driver + always needed it, so installing the package alone no longer fails on import. + +## [0.1.0] - 2026-08-18 + +### Added +- `hpe_officeconnect` driver for HPE OfficeConnect 1820 and 1920S switches, read-only + over the web UI (HTTP, or HTTPS once a certificate is installed): facts, + interfaces, VLANs with their tagged and untagged ports, the MAC address table and + LLDP neighbours. diff --git a/napalm_hpe_officeconnect/py.typed b/napalm_hpe_officeconnect/py.typed new file mode 100644 index 0000000..e69de29 diff --git a/pyproject.toml b/pyproject.toml index b2901aa..e96c26d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,5 +1,5 @@ [build-system] -requires = ["setuptools>=64", "wheel"] +requires = ["setuptools>=77"] build-backend = "setuptools.build_meta" [project] @@ -7,20 +7,18 @@ name = "napalm-hpe-officeconnect" version = "0.1.0" description = "NAPALM driver for HPE OfficeConnect 1820 / 1920S web-managed switches (HTTP only, no CLI)" readme = "README.md" -license = { text = "Apache-2.0" } -requires-python = ">=3.8" +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.8", - "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", ] @@ -29,16 +27,17 @@ classifiers = [ # which parse with ast.literal_eval — see parsers.extract_data_set. dependencies = [ "napalm>=4.0.0", + "napalm-device-types>=4.21.1", "requests>=2.25.0", - "urllib3", + "urllib3>=1.23", ] [project.optional-dependencies] dev = [ - "pytest", - "pytest-cov", - "black", - "ruff", + "pytest>=8", + "pytest-cov>=5", + "mypy>=1.11", + "ruff>=0.6", ] [project.entry-points."napalm.drivers"] @@ -46,11 +45,16 @@ hpe_officeconnect = "napalm_hpe_officeconnect:OfficeConnectDriver" [project.urls] Repository = "https://git.netork.io/NAPALM/napalm-hpe-officeconnect" +Issues = "https://git.netork.io/NAPALM/napalm-hpe-officeconnect/issues" +Changelog = "https://git.netork.io/NAPALM/napalm-hpe-officeconnect/src/branch/main/CHANGELOG.md" [tool.setuptools.packages.find] where = ["."] include = ["napalm_hpe_officeconnect*"] +[tool.setuptools.package-data] +napalm_hpe_officeconnect = ["py.typed"] + [tool.ruff] line-length = 100 target-version = "py310" @@ -61,3 +65,27 @@ 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_hpe_officeconnect.officeconnect"] +ignore_errors = true + +[tool.pytest.ini_options] +testpaths = ["tests"] + +[tool.coverage.run] +source = ["napalm_hpe_officeconnect"] + +[tool.coverage.report] +fail_under = 91 diff --git a/tests/quality_baseline.json b/tests/quality_baseline.json new file mode 100644 index 0000000..226a758 --- /dev/null +++ b/tests/quality_baseline.json @@ -0,0 +1,10 @@ +{ + "coverage_floor": 91.0, + "function_complexity": {}, + "function_lines": {}, + "mypy_relaxed": [ + "napalm_hpe_officeconnect.officeconnect" + ], + "python_file_lines": {}, + "untyped_public": [] +} From b5f3e3149868b479b3a8a7ea60e7a1d68d2e1ab5 Mon Sep 17 00:00:00 2001 From: Christian Manivong Date: Fri, 23 Oct 2026 10:29:04 +0200 Subject: [PATCH 3/3] chore(release): 0.2.0 --- CHANGELOG.md | 4 ++++ pyproject.toml | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d6c9ab1..85b8b95 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,10 @@ All notable changes to this driver. The format follows ## [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 diff --git a/pyproject.toml b/pyproject.toml index e96c26d..8818332 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta" [project] name = "napalm-hpe-officeconnect" -version = "0.1.0" +version = "0.2.0" description = "NAPALM driver for HPE OfficeConnect 1820 / 1920S web-managed switches (HTTP only, no CLI)" readme = "README.md" license = "Apache-2.0"