chore: adopt the NAPALM driver standard
driver / standard (pull_request) Successful in 14s
driver / lint (pull_request) Successful in 11s
driver / types (pull_request) Successful in 45s
driver / test (3.10) (pull_request) Successful in 44s
driver / test (3.11) (pull_request) Successful in 44s
driver / test (3.12) (pull_request) Successful in 43s
driver / test (3.13) (pull_request) Successful in 37s
driver / lowest (pull_request) Successful in 22s
driver / security (pull_request) Successful in 46s
driver / build (pull_request) Successful in 22s
CI / driver (pull_request) Successful in 5m30s
driver / publish (pull_request) Skipped

- 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 %).
This commit is contained in:
Christian Manivong committed 2026-10-23 08:44:17 +02:00
1 parent 06a39b49b3
commit ed928c22b0
7 files changed
+90 -59

No files matched your search

+15
View File
@@ -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 }}
-48
View File
@@ -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/*
+1
View File
@@ -9,3 +9,4 @@ venv/
.ruff_cache/ .ruff_cache/
.coverage .coverage
htmlcov/ htmlcov/
.mypy_cache/
+25
View File
@@ -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.
View File
Whitespace-only changes.
+39 -11
View File
@@ -1,5 +1,5 @@
[build-system] [build-system]
requires = ["setuptools>=64", "wheel"] requires = ["setuptools>=77"]
build-backend = "setuptools.build_meta" build-backend = "setuptools.build_meta"
[project] [project]
@@ -7,20 +7,18 @@ name = "napalm-hpe-officeconnect"
version = "0.1.0" version = "0.1.0"
description = "NAPALM driver for HPE OfficeConnect 1820 / 1920S web-managed switches (HTTP only, no CLI)" description = "NAPALM driver for HPE OfficeConnect 1820 / 1920S web-managed switches (HTTP only, no CLI)"
readme = "README.md" readme = "README.md"
license = { text = "Apache-2.0" } license = "Apache-2.0"
requires-python = ">=3.8" requires-python = ">=3.10"
authors = [ authors = [
{ name = "Christian Manivong" }, { name = "Christian Manivong" },
] ]
classifiers = [ classifiers = [
"Topic :: Utilities", "Topic :: Utilities",
"License :: OSI Approved :: Apache Software License",
"Programming Language :: Python :: 3", "Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11", "Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12", "Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3.13",
"Operating System :: POSIX :: Linux", "Operating System :: POSIX :: Linux",
"Operating System :: MacOS", "Operating System :: MacOS",
] ]
@@ -29,16 +27,17 @@ classifiers = [
# which parse with ast.literal_eval — see parsers.extract_data_set. # which parse with ast.literal_eval — see parsers.extract_data_set.
dependencies = [ dependencies = [
"napalm>=4.0.0", "napalm>=4.0.0",
"napalm-device-types>=4.21.1",
"requests>=2.25.0", "requests>=2.25.0",
"urllib3", "urllib3>=1.23",
] ]
[project.optional-dependencies] [project.optional-dependencies]
dev = [ dev = [
"pytest", "pytest>=8",
"pytest-cov", "pytest-cov>=5",
"black", "mypy>=1.11",
"ruff", "ruff>=0.6",
] ]
[project.entry-points."napalm.drivers"] [project.entry-points."napalm.drivers"]
@@ -46,11 +45,16 @@ hpe_officeconnect = "napalm_hpe_officeconnect:OfficeConnectDriver"
[project.urls] [project.urls]
Repository = "https://git.netork.io/NAPALM/napalm-hpe-officeconnect" 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] [tool.setuptools.packages.find]
where = ["."] where = ["."]
include = ["napalm_hpe_officeconnect*"] include = ["napalm_hpe_officeconnect*"]
[tool.setuptools.package-data]
napalm_hpe_officeconnect = ["py.typed"]
[tool.ruff] [tool.ruff]
line-length = 100 line-length = 100
target-version = "py310" target-version = "py310"
@@ -61,3 +65,27 @@ select = ["E", "F", "I", "UP", "B"]
[tool.ruff.lint.per-file-ignores] [tool.ruff.lint.per-file-ignores]
# Recorded device output keeps its lines. # Recorded device output keeps its lines.
"tests/**" = ["E501"] "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
+10
View File
@@ -0,0 +1,10 @@
{
"coverage_floor": 91.0,
"function_complexity": {},
"function_lines": {},
"mypy_relaxed": [
"napalm_hpe_officeconnect.officeconnect"
],
"python_file_lines": {},
"untyped_public": []
}