netbox-stratagram 1.0.2__tar.gz

netbox_stratagram-1.0.2/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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, whether in Source or
+      Object form, 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 modifications
+      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 any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to 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 otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently 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 combination of their Contribution(s)
+      with 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 a Contribution incorporated 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, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, 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 copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   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 warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this 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 consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), 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 act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   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. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

netbox_stratagram-1.0.2/NOTICE

@@ -0,0 +1,6 @@
+Stratagram
+Copyright 2026 Shin Sterneck
+
+This product includes Stratagram, a network diagram editor with a NetBox
+plugin, developed by Shin Sterneck and licensed under the Apache License,
+Version 2.0 (see LICENSE).

netbox_stratagram-1.0.2/PKG-INFO

@@ -0,0 +1,142 @@
+Metadata-Version: 2.4
+Name: netbox-stratagram
+Version: 1.0.2
+Summary: NetBox plugin: network diagrams of sites, drawn and edited in NetBox with Stratagram
+Author: Shin Sterneck
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://stratagram.app/
+Project-URL: Source, https://github.com/shinsterneck/stratagram
+Project-URL: Issues, https://github.com/shinsterneck/stratagram/issues
+Keywords: netbox,netbox-plugin,diagram,topology
+Classifier: Framework :: Django
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.12.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+License-File: THIRD-PARTY-LICENSES.txt
+Dynamic: license-file
+
+# NetBox Stratagram
+
+Network diagrams of NetBox sites, drawn from their devices and cables and
+edited in the browser on each site's **Diagram** tab, with the Stratagram
+editor (the same as the desktop app, compiled to WebAssembly).
+
+- The first time, the tab draws the site as NetBox has it: devices with
+  their cabled interfaces as ports, cables as lines, laid out top down
+  (internet and firewalls above, servers below). Device types come from the
+  device roles, line types from the interfaces (802.1Q trunk, layer 3 when
+  routed on both ends, layer 2 for access ports). Provider circuits become
+  clouds. Patch panels (by role, or devices with front ports and no other
+  role) are drawn with numbered sockets, one per front port, of the front
+  ports' type (RJ45, LC or SC), and as wide as they need. Cables to front
+  ports plug into their sockets, cables to rear ports come out behind the
+  socket of the front port they map to. Switches show their front too: their
+  physical interfaces as ports, odd ones on top and even ones below, copper
+  ones first and the others as SFP uplinks, each cable in its port.
+- Each of the site's locations gets a sheet of its own after the site's:
+  the devices in the location (and in the locations inside it), plus the
+  devices elsewhere they are cabled to, on the layer "Other locations"
+  (marked with its name). A location's own **Diagram** tab shows the
+  site's diagram open on that sheet.
+- Each type of device is on a layer of its own (Internet, Firewalls,
+  Routers, Switches, Patch panels, Servers...) and the cables on the layer
+  Cables, to show or hide them by type; each device has a sub-layer of its
+  own under its type's, named after it (renamed with it), to show or hide
+  devices one by one (unfold the type's layer with ▸). The cabling stays end to end: with
+  the patch panels hidden, a server's line goes straight to the switch port
+  it is patched through to (NetBox's cable path), and hidden cables take
+  their end-to-end lines with them. A diagram saved before this gets the
+  layers at its next **Refresh from NetBox** (what you drew yourself stays
+  where it is; a device you later move to another layer stays there).
+- Arrange it, add notes, a frame, layers..., then **Save**: the diagram is
+  kept in NetBox (one per site, in the change log).
+- **Refresh from NetBox** adds new devices and cables, renames what was
+  renamed and sets aside what is gone on the layer "Gone from NetBox";
+  nothing you placed moves, and Ctrl+Z undoes it. It does so on every
+  sheet: renamed locations rename their sheets, and new locations get new
+  sheets (a diagram saved before locations had sheets gets them too).
+- Export SVG, PNG or draw.io from the editor's Export menu.
+- Light, Dark and Neon themes (the selector in the editor's toolbar): the
+  editor follows NetBox's own light/dark switch until you pick one, which
+  is then remembered in your browser. SVG and PNG exports come out in the
+  theme; the saved diagram keeps its colors.
+
+Requires NetBox 4.5, 4.6 or 4.7.
+
+## Install
+
+Install it from [PyPI](https://pypi.org/project/netbox-stratagram/) into
+NetBox's virtual environment:
+
+```sh
+sudo /opt/netbox/venv/bin/pip install netbox-stratagram
+```
+
+With [netbox-docker](https://github.com/netbox-community/netbox-docker), add
+`netbox-stratagram` to `plugin_requirements.txt` and build the image (see
+netbox-docker's guide to plugins; `collectstatic` is part of it).
+
+To build the package yourself (needs Rust with the `wasm32-unknown-unknown`
+target and `wasm-bindgen-cli` 0.2.129, see the main README, `pip install
+build`, and `cargo install cargo-about` for the licenses of the libraries
+built into the editor, which go into the package as
+`THIRD-PARTY-LICENSES.txt`):
+
+```sh
+netbox-plugin/build.sh          # makes netbox-plugin/dist/netbox_stratagram-*.whl
+```
+
+and install that wheel instead. Then enable the plugin in `configuration.py`:
+
+```python
+PLUGINS = ["netbox_stratagram"]
+PLUGINS_CONFIG = {
+    "netbox_stratagram": {
+        # Device type by device role (slug or name), before the built-in guesses.
+        "kinds": {"patch-panel": "switch", "dmz-host": "server"},
+        # Also draw devices without a cable to another device.
+        "all_devices": False,
+        # Each type of device on a layer of its own, the cables on one.
+        "type_layers": True,
+        # How the cables run, and new lines drawn by hand: "orthogonal",
+        # "straight" or "around" (orthogonal, around devices in between).
+        "routing": "orthogonal",
+        # Device types drawn with their ports as a front, like a switch's:
+        # any of "switch", "router", "firewall", "server".
+        "fronts": ["switch"],
+    },
+}
+```
+
+Then, as for any plugin:
+
+```sh
+python3 manage.py migrate
+python3 manage.py collectstatic --no-input
+```
+
+Your web server should serve `.wasm` files as `application/wasm` (nginx
+does by default; elsewhere the editor still loads, a little slower).
+
+## Permissions
+
+The Diagram tab (of sites and locations) shows to those who may view the
+site and *site diagrams* (`netbox_stratagram.view_sitediagram`); grant it
+to everyone who should see the diagrams (superusers have it). A saved
+diagram outside the constraints of their view permission is not shown
+(nor can it be saved over). Drawn afresh or refreshed, the drawing only has
+the devices and cables they may view.
+
+Saving needs the permission to add (the first time) or change site
+diagrams (`netbox_stratagram.add_sitediagram`,
+`netbox_stratagram.change_sitediagram`), with their constraints: a diagram
+saved outside them (constraints on `site__region`, say) is undone and the
+save refused, as in NetBox's own edit views.
+
+## License
+
+Copyright 2026 Shin Sterneck. Licensed under the Apache License, Version
+2.0; the package includes the license and the NOTICE file.

netbox_stratagram-1.0.2/README.md

@@ -0,0 +1,122 @@
+# NetBox Stratagram
+
+Network diagrams of NetBox sites, drawn from their devices and cables and
+edited in the browser on each site's **Diagram** tab, with the Stratagram
+editor (the same as the desktop app, compiled to WebAssembly).
+
+- The first time, the tab draws the site as NetBox has it: devices with
+  their cabled interfaces as ports, cables as lines, laid out top down
+  (internet and firewalls above, servers below). Device types come from the
+  device roles, line types from the interfaces (802.1Q trunk, layer 3 when
+  routed on both ends, layer 2 for access ports). Provider circuits become
+  clouds. Patch panels (by role, or devices with front ports and no other
+  role) are drawn with numbered sockets, one per front port, of the front
+  ports' type (RJ45, LC or SC), and as wide as they need. Cables to front
+  ports plug into their sockets, cables to rear ports come out behind the
+  socket of the front port they map to. Switches show their front too: their
+  physical interfaces as ports, odd ones on top and even ones below, copper
+  ones first and the others as SFP uplinks, each cable in its port.
+- Each of the site's locations gets a sheet of its own after the site's:
+  the devices in the location (and in the locations inside it), plus the
+  devices elsewhere they are cabled to, on the layer "Other locations"
+  (marked with its name). A location's own **Diagram** tab shows the
+  site's diagram open on that sheet.
+- Each type of device is on a layer of its own (Internet, Firewalls,
+  Routers, Switches, Patch panels, Servers...) and the cables on the layer
+  Cables, to show or hide them by type; each device has a sub-layer of its
+  own under its type's, named after it (renamed with it), to show or hide
+  devices one by one (unfold the type's layer with ▸). The cabling stays end to end: with
+  the patch panels hidden, a server's line goes straight to the switch port
+  it is patched through to (NetBox's cable path), and hidden cables take
+  their end-to-end lines with them. A diagram saved before this gets the
+  layers at its next **Refresh from NetBox** (what you drew yourself stays
+  where it is; a device you later move to another layer stays there).
+- Arrange it, add notes, a frame, layers..., then **Save**: the diagram is
+  kept in NetBox (one per site, in the change log).
+- **Refresh from NetBox** adds new devices and cables, renames what was
+  renamed and sets aside what is gone on the layer "Gone from NetBox";
+  nothing you placed moves, and Ctrl+Z undoes it. It does so on every
+  sheet: renamed locations rename their sheets, and new locations get new
+  sheets (a diagram saved before locations had sheets gets them too).
+- Export SVG, PNG or draw.io from the editor's Export menu.
+- Light, Dark and Neon themes (the selector in the editor's toolbar): the
+  editor follows NetBox's own light/dark switch until you pick one, which
+  is then remembered in your browser. SVG and PNG exports come out in the
+  theme; the saved diagram keeps its colors.
+
+Requires NetBox 4.5, 4.6 or 4.7.
+
+## Install
+
+Install it from [PyPI](https://pypi.org/project/netbox-stratagram/) into
+NetBox's virtual environment:
+
+```sh
+sudo /opt/netbox/venv/bin/pip install netbox-stratagram
+```
+
+With [netbox-docker](https://github.com/netbox-community/netbox-docker), add
+`netbox-stratagram` to `plugin_requirements.txt` and build the image (see
+netbox-docker's guide to plugins; `collectstatic` is part of it).
+
+To build the package yourself (needs Rust with the `wasm32-unknown-unknown`
+target and `wasm-bindgen-cli` 0.2.129, see the main README, `pip install
+build`, and `cargo install cargo-about` for the licenses of the libraries
+built into the editor, which go into the package as
+`THIRD-PARTY-LICENSES.txt`):
+
+```sh
+netbox-plugin/build.sh          # makes netbox-plugin/dist/netbox_stratagram-*.whl
+```
+
+and install that wheel instead. Then enable the plugin in `configuration.py`:
+
+```python
+PLUGINS = ["netbox_stratagram"]
+PLUGINS_CONFIG = {
+    "netbox_stratagram": {
+        # Device type by device role (slug or name), before the built-in guesses.
+        "kinds": {"patch-panel": "switch", "dmz-host": "server"},
+        # Also draw devices without a cable to another device.
+        "all_devices": False,
+        # Each type of device on a layer of its own, the cables on one.
+        "type_layers": True,
+        # How the cables run, and new lines drawn by hand: "orthogonal",
+        # "straight" or "around" (orthogonal, around devices in between).
+        "routing": "orthogonal",
+        # Device types drawn with their ports as a front, like a switch's:
+        # any of "switch", "router", "firewall", "server".
+        "fronts": ["switch"],
+    },
+}
+```
+
+Then, as for any plugin:
+
+```sh
+python3 manage.py migrate
+python3 manage.py collectstatic --no-input
+```
+
+Your web server should serve `.wasm` files as `application/wasm` (nginx
+does by default; elsewhere the editor still loads, a little slower).
+
+## Permissions
+
+The Diagram tab (of sites and locations) shows to those who may view the
+site and *site diagrams* (`netbox_stratagram.view_sitediagram`); grant it
+to everyone who should see the diagrams (superusers have it). A saved
+diagram outside the constraints of their view permission is not shown
+(nor can it be saved over). Drawn afresh or refreshed, the drawing only has
+the devices and cables they may view.
+
+Saving needs the permission to add (the first time) or change site
+diagrams (`netbox_stratagram.add_sitediagram`,
+`netbox_stratagram.change_sitediagram`), with their constraints: a diagram
+saved outside them (constraints on `site__region`, say) is undone and the
+save refused, as in NetBox's own edit views.
+
+## License
+
+Copyright 2026 Shin Sterneck. Licensed under the Apache License, Version
+2.0; the package includes the license and the NOTICE file.