v0.2.1 - hide normal changelogs

Author: ITJamie

README.md

@@ -30,10 +30,10 @@ Minium version is 4.0.5 of netbox. Otherwise no changelog diff's will show up
 For adding to a NetBox Docker setup see
 [the general instructions for using netbox-docker with plugins](https://github.com/netbox-community/netbox-docker/wiki/Using-Netbox-Plugins).
 
-While this is still in development and not yet on pypi you can install with pip:
+to install from pip:
 
 ```bash
-pip install git+https://github.com/ITJamie/netbox-changelog-diff-plugin
+pip install netbox-changelog-diff-plugin
 ```
 
 or by adding to your `local_requirements.txt` or `plugin_requirements.txt` (netbox-docker):
@@ -51,7 +51,12 @@ PLUGINS = [
 ]
 
 PLUGINS_CONFIG = {
-    "netbox_changelog_diff_plugin": {},
+    "netbox_changelog_diff_plugin": {
+        # can be json or yaml, yaml is more readable
+        "change_log_format": "yaml", 
+        # will hide the native changelog diff's if `True` and only show new ones
+        "hide_native_diff": False
+    },
 }
 ```
 

netbox_changelog_diff_plugin/__init__.py

@@ -2,7 +2,7 @@
 
 __author__ = """Jamie Murphy"""
 __email__ = "[email protected]"
-__version__ = "0.2.0"
+__version__ = "0.2.1"
 
 
 from netbox.plugins import PluginConfig
@@ -16,6 +16,7 @@ class ChangeLogDiffConfig(PluginConfig):
     base_url = "netbox_changelog_diff_plugin"
     default_settings = {
         "change_log_format": "yaml",
+        "hide_native_diff": False,
     }
 
 

netbox_changelog_diff_plugin/template_content.py

@@ -1,5 +1,6 @@
 from netbox.plugins import PluginTemplateExtension
 from .utilities.html_differ import styled_diff
+from .utils import get_plugin_setting
 
 
 class ChangeLogDiffTemplateExtension(PluginTemplateExtension):
@@ -13,8 +14,13 @@ def full_width_page(self):
             prechange_data or dict(),
             postchange_data or dict(),
         )
+        hide_native_diff = get_plugin_setting("hide_native_diff")
         return self.render(
-            "netbox_changelog_diff_plugin/changelogdiff.html", extra_context={"leftrightdiffhtml": leftrightdiffhtml}
+            "netbox_changelog_diff_plugin/changelogdiff.html",
+            extra_context={
+                "leftrightdiffhtml": leftrightdiffhtml,
+                "hide_native_diff": hide_native_diff,
+            },
         )
 
 

netbox_changelog_diff_plugin/templates/netbox_changelog_diff_plugin/changelogdiff.html

@@ -1,6 +1,22 @@
 {% load helpers %}
 {% load i18n %}
 
+{% if hide_native_diff %}
+<script type="text/javascript">
+  window.onload = function() {
+    var headers = document.querySelectorAll('h2.card-header');
+    headers.forEach(function(header) {
+      if (header.textContent.trim() === 'Pre-Change Data' || header.textContent.trim() === 'Post-Change Data') {
+        var parentDiv = header.closest('div.card');
+        if (parentDiv) {
+          parentDiv.style.display = 'none';
+        }
+      }
+    });
+  };
+</script>
+{% endif %}
+
 <script type="text/javascript">
   var styles = `
 span.left_diff_change {
@@ -59,7 +75,7 @@
   <div class="col col-md-6">
       <div class="card">
           <h5 class="card-header">
-              {% trans "Pre-Change Data" %}
+              {% trans "Pre-Change Data (Changelog Diff Plugin)" %}
           </h5>
           <div class="card-body">
               <pre class="change-data" style="padding-top: 0; padding-bottom: 0;">
@@ -71,7 +87,7 @@ <h5 class="card-header">
   <div class="col col-md-6">
       <div class="card">
           <h5 class="card-header" >
-              {% trans "Post-Change Data" %}
+              {% trans "Post-Change Data (Changelog Diff Plugin)" %}
           </h5>
           <div class="card-body">
               <pre class="change-data" style="padding-top: 0; padding-bottom: 0;">
@@ -80,4 +96,4 @@ <h5 class="card-header" >
           </div>
       </div>
   </div>
-</div>
+</div>

pyproject.toml

@@ -7,7 +7,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name =  "netbox-changelog-diff-plugin"
-version = "0.2.0"
+version = "0.2.1"
 authors = [
     {name = "Jamie Murphy", email = "[email protected]"},
 ]