napalm-device-types 0.1.0__tar.gz

napalm_device_types-0.1.0/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.

napalm_device_types-0.1.0/PKG-INFO

@@ -0,0 +1,194 @@
+Metadata-Version: 2.4
+Name: napalm-device-types
+Version: 0.1.0
+Summary: Abstract device-type base classes for NAPALM drivers
+Author-email: Christian Manivong <christian@manivong.de>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/chrismanivong/napalm-device-types
+Project-URL: Repository, https://github.com/chrismanivong/napalm-device-types
+Project-URL: Issues, https://github.com/chrismanivong/napalm-device-types/issues
+Keywords: napalm,network,automation,driver,access-point,switch,firewall,hypervisor,storage,nas
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: System :: Networking
+Classifier: Topic :: System :: Systems Administration
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: napalm>=4.0
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: license-file
+
+# napalm-device-types
+
+Abstract intermediate device-type base classes for [NAPALM](https://napalm.readthedocs.io/) drivers.
+
+Instead of inheriting directly from `napalm.base.NetworkDriver`, a driver can inherit from one of the device-type classes here to gain a richer, type-specific contract:
+
+```python
+# without napalm-device-types
+class OpenWrtDriver(NetworkDriver):
+    ...
+
+# with napalm-device-types
+from napalm_device_types import AccessPointDriver
+
+class OpenWrtDriver(AccessPointDriver):
+    ...
+```
+
+## Why?
+
+NAPALM's `NetworkDriver` defines a common interface for all network devices. In practice, devices fall into distinct categories with very different capabilities. A switch exposes spanning-tree and PoE data; a firewall exposes NAT tables and VPN tunnels; a NAS exposes disk pools and shares. Writing these methods directly in a concrete driver mixes concerns and makes drivers harder to discover and compare.
+
+`napalm-device-types` sits in between: it adds one well-typed layer of abstract methods per device category, so every driver for the same category exposes the same interface.
+
+## Installation
+
+```bash
+pip install napalm-device-types
+```
+
+Requires Python ≥ 3.9 and NAPALM ≥ 4.0.
+
+## Available base classes
+
+| Class | Target devices | Example implementations |
+|---|---|---|
+| `AccessPointDriver` | Wireless access points | OpenWrt, Ubiquiti UniFi, Cisco Meraki AP |
+| `SwitchDriver` | Ethernet switches | Cisco IOS, Arista EOS, Juniper EX |
+| `FirewallDriver` | Firewalls & UTM appliances | pfSense, Fortinet FortiOS, Cisco ASA |
+| `HypervisorDriver` | Hypervisors & virtualisation platforms | Proxmox VE, VMware ESXi, KVM/libvirt |
+| `StorageDriver` | Storage appliances & NAS/SAN | TrueNAS, Synology DSM, QNAP QTS |
+
+## Usage
+
+### Access Point
+
+```python
+from napalm_device_types import AccessPointDriver
+
+class OpenWrtDriver(AccessPointDriver):
+
+    def get_wireless_clients(self):
+        # return List[WirelessClientDict]
+        ...
+
+    def get_ssids(self):
+        # return Dict[str, SSIDDict]
+        ...
+```
+
+### Switch
+
+```python
+from napalm_device_types import SwitchDriver
+
+class CiscoIOSDriver(SwitchDriver):
+
+    def get_spanning_tree(self):
+        # return Dict[str, SpanningTreeDict]
+        ...
+
+    def get_poe_status(self):
+        # return PoESummaryDict
+        ...
+```
+
+### Firewall
+
+```python
+from napalm_device_types import FirewallDriver
+
+class PfSenseDriver(FirewallDriver):
+
+    def get_nat_translations(self):
+        # return List[NATTranslationDict]
+        ...
+
+    def get_vpn_tunnels(self):
+        # return Dict[str, VPNTunnelDict]
+        ...
+```
+
+### Hypervisor
+
+```python
+from napalm_device_types import HypervisorDriver
+
+class ProxmoxDriver(HypervisorDriver):
+
+    def get_vms(self):
+        # return List[VMDict]
+        ...
+
+    def snapshot_create(self, name, snapshot, description="", include_memory=False):
+        ...
+```
+
+### Storage / NAS
+
+```python
+from napalm_device_types import StorageDriver
+
+class TrueNASDriver(StorageDriver):
+
+    def get_disks(self):
+        # return List[PhysicalDiskDict]
+        ...
+
+    def get_shares(self):
+        # return Dict[str, NASShareDict]
+        ...
+```
+
+## Return types
+
+All return types are `TypedDict` classes defined in `napalm_device_types.models`. Import them directly for type annotations in your driver:
+
+```python
+from napalm_device_types.models import (
+    PhysicalDiskDict,
+    DiskPoolDict,
+    NASShareDict,
+    VolumeSnapshotDict,
+)
+```
+
+## Development
+
+```bash
+git clone https://github.com/chrismanivong/napalm-device-types.git
+cd napalm-device-types
+pip install -e ".[dev]"
+```
+
+Run type-checking:
+
+```bash
+mypy napalm_device_types
+```
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/router-driver`)
+3. Implement your changes
+4. Open a Pull Request
+
+## License
+
+Apache-2.0 – see [LICENSE](LICENSE) for details.

napalm_device_types-0.1.0/README.md

@@ -0,0 +1,160 @@
+# napalm-device-types
+
+Abstract intermediate device-type base classes for [NAPALM](https://napalm.readthedocs.io/) drivers.
+
+Instead of inheriting directly from `napalm.base.NetworkDriver`, a driver can inherit from one of the device-type classes here to gain a richer, type-specific contract:
+
+```python
+# without napalm-device-types
+class OpenWrtDriver(NetworkDriver):
+    ...
+
+# with napalm-device-types
+from napalm_device_types import AccessPointDriver
+
+class OpenWrtDriver(AccessPointDriver):
+    ...
+```
+
+## Why?
+
+NAPALM's `NetworkDriver` defines a common interface for all network devices. In practice, devices fall into distinct categories with very different capabilities. A switch exposes spanning-tree and PoE data; a firewall exposes NAT tables and VPN tunnels; a NAS exposes disk pools and shares. Writing these methods directly in a concrete driver mixes concerns and makes drivers harder to discover and compare.
+
+`napalm-device-types` sits in between: it adds one well-typed layer of abstract methods per device category, so every driver for the same category exposes the same interface.
+
+## Installation
+
+```bash
+pip install napalm-device-types
+```
+
+Requires Python ≥ 3.9 and NAPALM ≥ 4.0.
+
+## Available base classes
+
+| Class | Target devices | Example implementations |
+|---|---|---|
+| `AccessPointDriver` | Wireless access points | OpenWrt, Ubiquiti UniFi, Cisco Meraki AP |
+| `SwitchDriver` | Ethernet switches | Cisco IOS, Arista EOS, Juniper EX |
+| `FirewallDriver` | Firewalls & UTM appliances | pfSense, Fortinet FortiOS, Cisco ASA |
+| `HypervisorDriver` | Hypervisors & virtualisation platforms | Proxmox VE, VMware ESXi, KVM/libvirt |
+| `StorageDriver` | Storage appliances & NAS/SAN | TrueNAS, Synology DSM, QNAP QTS |
+
+## Usage
+
+### Access Point
+
+```python
+from napalm_device_types import AccessPointDriver
+
+class OpenWrtDriver(AccessPointDriver):
+
+    def get_wireless_clients(self):
+        # return List[WirelessClientDict]
+        ...
+
+    def get_ssids(self):
+        # return Dict[str, SSIDDict]
+        ...
+```
+
+### Switch
+
+```python
+from napalm_device_types import SwitchDriver
+
+class CiscoIOSDriver(SwitchDriver):
+
+    def get_spanning_tree(self):
+        # return Dict[str, SpanningTreeDict]
+        ...
+
+    def get_poe_status(self):
+        # return PoESummaryDict
+        ...
+```
+
+### Firewall
+
+```python
+from napalm_device_types import FirewallDriver
+
+class PfSenseDriver(FirewallDriver):
+
+    def get_nat_translations(self):
+        # return List[NATTranslationDict]
+        ...
+
+    def get_vpn_tunnels(self):
+        # return Dict[str, VPNTunnelDict]
+        ...
+```
+
+### Hypervisor
+
+```python
+from napalm_device_types import HypervisorDriver
+
+class ProxmoxDriver(HypervisorDriver):
+
+    def get_vms(self):
+        # return List[VMDict]
+        ...
+
+    def snapshot_create(self, name, snapshot, description="", include_memory=False):
+        ...
+```
+
+### Storage / NAS
+
+```python
+from napalm_device_types import StorageDriver
+
+class TrueNASDriver(StorageDriver):
+
+    def get_disks(self):
+        # return List[PhysicalDiskDict]
+        ...
+
+    def get_shares(self):
+        # return Dict[str, NASShareDict]
+        ...
+```
+
+## Return types
+
+All return types are `TypedDict` classes defined in `napalm_device_types.models`. Import them directly for type annotations in your driver:
+
+```python
+from napalm_device_types.models import (
+    PhysicalDiskDict,
+    DiskPoolDict,
+    NASShareDict,
+    VolumeSnapshotDict,
+)
+```
+
+## Development
+
+```bash
+git clone https://github.com/chrismanivong/napalm-device-types.git
+cd napalm-device-types
+pip install -e ".[dev]"
+```
+
+Run type-checking:
+
+```bash
+mypy napalm_device_types
+```
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/router-driver`)
+3. Implement your changes
+4. Open a Pull Request
+
+## License
+
+Apache-2.0 – see [LICENSE](LICENSE) for details.

napalm_device_types-0.1.0/napalm_device_types/__init__.py

@@ -0,0 +1,37 @@
+"""
+napalm-device-types
+~~~~~~~~~~~~~~~~~~~
+
+Abstract device-type base classes for NAPALM drivers.
+
+Instead of inheriting directly from ``napalm.base.NetworkDriver``, a driver
+can inherit from one of the device-type classes defined here to gain
+type-specific abstract methods and a clearer contract::
+
+    from napalm_device_types import AccessPointDriver
+
+    class OpenWrtDriver(AccessPointDriver):
+        ...
+
+Available base classes:
+
+* :class:`~napalm_device_types.access_point.AccessPointDriver`
+* :class:`~napalm_device_types.switch.SwitchDriver`
+* :class:`~napalm_device_types.firewall.FirewallDriver`
+* :class:`~napalm_device_types.hypervisor.HypervisorDriver`
+* :class:`~napalm_device_types.storage.StorageDriver`
+"""
+
+from napalm_device_types.access_point import AccessPointDriver
+from napalm_device_types.firewall import FirewallDriver
+from napalm_device_types.hypervisor import HypervisorDriver
+from napalm_device_types.storage import StorageDriver
+from napalm_device_types.switch import SwitchDriver
+
+__all__ = [
+    "AccessPointDriver",
+    "FirewallDriver",
+    "HypervisorDriver",
+    "StorageDriver",
+    "SwitchDriver",
+]