chore: adopt the NAPALM driver standard #20

Merged

christianmanivong merged 4 commits from chore/driver-standard into main 2026-10-23 09:40:30 +00:00

Conversation 0 Commits 4 Files Changed 10

+129 -86

christianmanivong commented 2026-10-23 06:35:07 +00:00

Owner

Copy link

Copy source

Summary

napalm-bsd adopts the NAPALM driver standard (https://git.netork.io/NAPALM/driver-standard).
Epic: NAPALM/driver-standard#2.

Changes

• style: ruff format and ruff check --fix with the standard's rule set (E, F, I, UP, B, line length 100, Python 3.10). Mechanical.
• fix: bandit is clean: nosec for the staging path on the device (B108, a mktemp template on the remote host) and for the wildcard listen address parsed from sockstat/netstat (B104, reported data, never a bind), now a named constant. No behaviour change.
• chore: CI in .gitea/ calling the shared workflow, .github/ removed; napalm-device-types >=4.21.1 from PyPI; py.typed, SPDX license, setuptools>=77, dev extra floors, Issues/Changelog URLs; strict mypy with napalm_bsd.base, napalm_bsd.freebsd and napalm_bsd.openbsd exempt; coverage floor 94 %; quality baseline; CHANGELOG entry.

Related Issue

Closes #19

Testing

Locally: 138 tests, coverage 94.63 %, ruff, mypy, bandit clean; napalm-standard check and
ratchet clean; build + twine check --strict pass.

## Summary napalm-bsd adopts the NAPALM driver standard (https://git.netork.io/NAPALM/driver-standard). Epic: NAPALM/driver-standard#2. ## Changes - **style**: ruff format and ruff check --fix with the standard's rule set (E, F, I, UP, B, line length 100, Python 3.10). Mechanical. - **fix**: bandit is clean: nosec for the staging path on the device (B108, a mktemp template on the remote host) and for the wildcard listen address parsed from sockstat/netstat (B104, reported data, never a bind), now a named constant. No behaviour change. - **chore**: CI in .gitea/ calling the shared workflow, .github/ removed; napalm-device-types >=4.21.1 from PyPI; py.typed, SPDX license, setuptools>=77, dev extra floors, Issues/Changelog URLs; strict mypy with napalm_bsd.base, napalm_bsd.freebsd and napalm_bsd.openbsd exempt; coverage floor 94 %; quality baseline; CHANGELOG entry. ## Related Issue Closes #19 ## Testing Locally: 138 tests, coverage 94.63 %, ruff, mypy, bandit clean; `napalm-standard check` and `ratchet` clean; build + `twine check --strict` pass.

christianmanivong added 3 commits 2026-10-23 06:35:08 +00:00

style: ruff format and the lint rules of the driver standard ... de00041b46

Mechanical: ruff format, and ruff check --fix with the rule set every NAPALM
driver uses (E, F, I, UP, B at line length 100, Python 3.10). What ruff
cannot fix comes in the next commit.

fix: what bandit and the remaining lint rules found ... 78576c225c

- nosec for the staging path on the device (B108); it is a mktemp
  template on the remote host, not a local temp file.
- The wildcard listen addresses parsed from sockstat/netstat are named
  constants with a nosec (B104): reported data, never a bind. The output
  is unchanged.
- ruff found nothing left after the mechanical pass.

chore: adopt the NAPALM driver standard ... 121343ee51

- CI moves to .gitea/workflows/ci.yml and calls the shared driver workflow
  of NAPALM/driver-standard; .github/ is gone.
- napalm-device-types >=4.21.1 from PyPI (the README no longer installs
  it from git), py.typed, SPDX license string, setuptools>=77, version
  floors on the dev extra, Issues and Changelog links on git.netork.io.
- mypy strict for the package; napalm_bsd.base, napalm_bsd.freebsd and
  napalm_bsd.openbsd are exempt for now (28 errors, mostly getters typed
  as plain dicts rather than the device-types TypedDicts), recorded in the
  quality baseline with three complex parsers. parse.py is strict after a
  one-line annotation.
- Coverage floor 94 % (measured 94.63 %).

christianmanivong added 1 commit 2026-10-23 08:29:02 +00:00

chore(release): 0.5.0 040a073863

christianmanivong merged commit 7ca6827421 into main 2026-10-23 09:40:30 +00:00

christianmanivong deleted branch chore/driver-standard 2026-10-23 09:40:30 +00:00

Sign in to join this conversation.

Reviewers

No Reviewers

Labels

Clear labels

bug

Something is broken

enhancement

New feature or request

tech-debt

Refactoring / cleanup / deferred debt

prio

P0

Road blocker: blocks other work, drop everything

prio

P1

Critical

prio

P2

Important and urgent

prio

P3

Important, not urgent

prio

P4

Neither important nor urgent

No labels

Milestone

No items

No Milestone

Projects

Clear projects

No projects

Assignees

Clear assignees

christianmanivong

No Assignees

1 Participants

Notifications

Subscribe

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: NAPALM/napalm-bsd#20