16050 Show script python_class name and description (#16185)

* 16050 Show script python_class name and description * 16050 change to use Meta.description * 16050 change to use Meta.description * 16050 remove module name customization from docs
netbox-community · Jun 6, 2024 · 8f87c72 · 8f87c72
1 parent 18b4340
commit 8f87c72
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 11 deletions.
diff --git a/docs/customization/custom-scripts.md b/docs/customization/custom-scripts.md
@@ -65,12 +65,6 @@ class AnotherCustomScript(Script):
 script_order = (MyCustomScript, AnotherCustomScript)
 ```
 
-## Module Attributes
-
-### `name`
-
-You can define `name` within a script module (the Python file which contains one or more scripts) to set the module name. If `name` is not defined, the module's file name will be used.
-
 ## Script Attributes
 
 Script attributes are defined under a class named `Meta` within the script. These are optional, but encouraged.

diff --git a/netbox/templates/extras/script/base.html b/netbox/templates/extras/script/base.html
@@ -4,7 +4,7 @@
 {% load log_levels %}
 {% load i18n %}
 
-{% block title %}{{ script }}{% endblock %}
+{% block title %}{{ script.python_class.name }}{% endblock %}
 
 {% block object_identifier %}
   {{ script.full_name }}
@@ -17,7 +17,7 @@
 
 {% block subtitle %}
   <div class="text-secondary fs-5">
-    {{ script.Meta.description|markdown }}
+    {{ script.python_class.Meta.description|markdown }}
   </div>
 {% endblock subtitle %}
 

diff --git a/netbox/templates/extras/script_list.html b/netbox/templates/extras/script_list.html
@@ -56,15 +56,15 @@ <h5 class="card-header justify-content-between" id="module{{ module.pk }}">
                 <tr>
                   <td>
                     {% if script.is_executable %}
-                      <a href="{% url 'extras:script' script.pk %}" id="{{ script.module }}.{{ script.class_name }}">{{ script.name }}</a>
+                      <a href="{% url 'extras:script' script.pk %}" id="{{ script.module }}.{{ script.class_name }}">{{ script.python_class.name }}</a>
                     {% else %}
-                      <a href="{% url 'extras:script_jobs' script.pk %}" id="{{ script.module }}.{{ script.class_name }}">{{ script.name }}</a>
+                      <a href="{% url 'extras:script_jobs' script.pk %}" id="{{ script.module }}.{{ script.class_name }}">{{ script.python_class.name }}</a>
                       <span class="text-danger">
                         <i class="mdi mdi-alert" title="{% trans "Script is no longer present in the source file" %}"></i>
                       </span>
                     {% endif %}
                   </td>
-                  <td>{{ script.description|markdown|placeholder }}</td>
+                  <td>{{ script.python_class.Meta.description|markdown|placeholder }}</td>
                   {% if last_job %}
                     <td>
                       <a href="{% url 'extras:script_result' job_pk=last_job.pk %}">{{ last_job.created|isodatetime }}</a>