nautobot 2.4.0b1__py3-none-any.whl → 2.4.1__py3-none-any.whl

nautobot/extras/plugins/tables.py

@@ -10,31 +10,31 @@ class InstalledAppsTable(tables.Table):
     """
 
     name = tables.Column(linkify=lambda record: reverse("apps:app_detail", kwargs={"app": record["app_label"]}))
-    package_name = tables.Column()
+    package = tables.Column(verbose_name="Package Name")
     author = tables.Column()
     author_email = tables.Column()
-    description = tables.Column()
+    headline = tables.Column()
     version = tables.Column()
     actions = tables.TemplateColumn(
         template_code="""
-            {% if record.actions.home %}
-            <a href="{% url record.actions.home %}" class="btn btn-success btn-xs" title="Home">
+            {% if record.home_url %}
+                <a href="{% url record.home_url %}" class="btn btn-primary btn-xs" title="Home">
             {% else %}
-            <a href="" class="btn btn-success btn-xs disabled" title="No home link provided">
+                <a href="" class="btn btn-primary btn-xs disabled" title="No home link provided">
             {% endif %}
                 <i class="mdi mdi-home"></i>
             </a>
-            {% if record.actions.configure %}
-            <a href="{% url record.actions.configure %}" class="btn btn-warning btn-xs" title="Configure">
+            {% if record.config_url %}
+                <a href="{% url record.config_url %}" class="btn btn-warning btn-xs" title="Configure">
             {% else %}
-            <a href="" class="btn btn-warning btn-xs disabled" title="No configuration link provided">
+                <a href="" class="btn btn-warning btn-xs disabled" title="No configuration link provided">
             {% endif %}
                 <i class="mdi mdi-cog"></i>
             </a>
-            {% if record.actions.docs %}
-            <a href="{% url record.actions.docs %}" class="btn btn-info btn-xs" title="Docs">
+            {% if record.docs_url %}
+                <a href="{% url record.docs_url %}" class="btn btn-info btn-xs" title="Docs">
             {% else %}
-            <a href="" class="btn btn-info btn-xs disabled" title="No docs provided">
+                <a href="" class="btn btn-info btn-xs disabled" title="No docs provided">
             {% endif %}
                 <i class="mdi mdi-book-open-page-variant"></i>
             </a>
@@ -47,7 +47,7 @@ class InstalledAppsTable(tables.Table):
         attrs = {
             "class": "table table-hover table-headings",
         }
-        default_columns = ("name", "description", "version", "actions")
+        default_columns = ("name", "headline", "version", "actions")
 
     def __init__(self, *args, user=None, **kwargs):
         super().__init__(*args, **kwargs)
@@ -83,7 +83,9 @@ class InstalledAppsTable(tables.Table):
     @property
     def configurable_columns(self):
         selected_columns = [
-            (name, self.columns[name].verbose_name) for name in self.sequence if name not in ["pk", "actions"]
+            (name, column.verbose_name)
+            for name, column in self.columns.items()
+            if name in self.sequence and name not in ["pk", "actions"]
         ]
         available_columns = [
             (name, column.verbose_name)
@@ -94,7 +96,7 @@ class InstalledAppsTable(tables.Table):
 
     @property
     def visible_columns(self):
-        return [name for name in self.sequence if self.columns[name].visible]
+        return [name for name, column in self.columns.items() if column.visible]
 
     def render_package_name(self, value):
         return format_html(f"<code>{value}</code>")

nautobot/extras/plugins/views.py

@@ -29,6 +29,55 @@ def load_marketplace_data():
     return marketplace_data
 
 
+def override_app_data_with_marketplace_data(package_name, app_data, marketplace_data):
+    """If the given package_name is in the marketplace_data, update/replace the app_data with marketplace_data."""
+    for marketplace_app in marketplace_data["apps"]:
+        if marketplace_app["package_name"] != package_name:
+            continue
+        for key in "author", "description", "headline", "availability", "name":
+            if marketplace_app.get(key, None):
+                app_data[key] = marketplace_app[key]
+        break
+    return app_data
+
+
+def extract_app_data(app_config, marketplace_data):
+    if app_config.name not in settings.PLUGINS:
+        return None
+    try:
+        reverse(app_config.home_view_name)
+        home_url = app_config.home_view_name
+    except NoReverseMatch:
+        home_url = None
+    try:
+        reverse(app_config.config_view_name)
+        config_url = app_config.config_view_name
+    except NoReverseMatch:
+        config_url = None
+    try:
+        reverse(app_config.docs_view_name)
+        docs_url = app_config.docs_view_name
+    except NoReverseMatch:
+        docs_url = None
+    return override_app_data_with_marketplace_data(
+        app_config.name,
+        {
+            "name": app_config.verbose_name,
+            "package": app_config.name,
+            "app_label": app_config.label,
+            "author": app_config.author,
+            "author_email": app_config.author_email,
+            "description": app_config.description,
+            "headline": app_config.description,
+            "version": app_config.version,
+            "home_url": home_url,
+            "config_url": config_url,
+            "docs_url": docs_url,
+        },
+        marketplace_data,
+    )
+
+
 class InstalledAppsView(GenericView):
     """
     View for listing all installed Apps.
@@ -37,40 +86,12 @@ class InstalledAppsView(GenericView):
     table = InstalledAppsTable
 
     def get(self, request):
+        marketplace_data = load_marketplace_data()
+        app_configs = apps.get_app_configs()
         data = []
-        for app in apps.get_app_configs():
-            if app.name in settings.PLUGINS:
-                try:
-                    reverse(app.home_view_name)
-                    home_url = app.home_view_name
-                except NoReverseMatch:
-                    home_url = None
-                try:
-                    reverse(app.config_view_name)
-                    config_url = app.config_view_name
-                except NoReverseMatch:
-                    config_url = None
-                try:
-                    reverse(app.docs_view_name)
-                    docs_url = app.docs_view_name
-                except NoReverseMatch:
-                    docs_url = None
-                data.append(
-                    {
-                        "name": app.verbose_name,
-                        "package_name": app.name,
-                        "app_label": app.label,
-                        "author": app.author,
-                        "author_email": app.author_email,
-                        "description": app.description,
-                        "version": app.version,
-                        "actions": {
-                            "home": home_url,
-                            "configure": config_url,
-                            "docs": docs_url,
-                        },
-                    }
-                )
+        for app_config in app_configs:
+            if app_data := extract_app_data(app_config, marketplace_data):
+                data.append(app_data)
         table = self.table(data, user=request.user)
 
         paginate = {
@@ -79,7 +100,6 @@ class InstalledAppsView(GenericView):
         }
         RequestConfig(request, paginate).configure(table)
 
-        marketplace_data = load_marketplace_data()
         app_icons = {app["package_name"]: app.get("icon") for app in marketplace_data["apps"]}
 
         # Determine user's preferred display
@@ -123,6 +143,7 @@ class InstalledAppDetailView(GenericView):
             request,
             "extras/plugin_detail.html",
             {
+                "app_data": extract_app_data(app_config, load_marketplace_data()),
                 "object": app_config,
             },
         )
@@ -138,35 +159,10 @@ class InstalledAppsAPIView(NautobotAPIVersionMixin, APIView):
     def get_view_name(self):
         return "Installed Apps"
 
-    @staticmethod
-    def _get_app_data(app_config):
-        try:
-            home_url = reverse(app_config.home_view_name)
-        except NoReverseMatch:
-            home_url = None
-        try:
-            config_url = reverse(app_config.config_view_name)
-        except NoReverseMatch:
-            config_url = None
-        try:
-            docs_url = reverse(app_config.docs_view_name)
-        except NoReverseMatch:
-            docs_url = None
-        return {
-            "name": app_config.verbose_name,
-            "package": app_config.name,
-            "author": app_config.author,
-            "author_email": app_config.author_email,
-            "description": app_config.description,
-            "version": app_config.version,
-            "home_url": home_url,
-            "config_url": config_url,
-            "docs_url": docs_url,
-        }
-
     @extend_schema(exclude=True)
     def get(self, request, format=None):  # pylint: disable=redefined-builtin
-        return Response([self._get_app_data(apps.get_app_config(app)) for app in settings.PLUGINS])
+        marketplace_data = load_marketplace_data()
+        return Response([extract_app_data(apps.get_app_config(app), marketplace_data) for app in settings.PLUGINS])
 
 
 class AppsAPIRootView(AuthenticatedAPIRootView):
@@ -193,7 +189,7 @@ class AppsAPIRootView(AuthenticatedAPIRootView):
         return entry
 
     @extend_schema(exclude=True)
-    def get(self, request, format=None):  # pylint: disable=redefined-builtin
+    def get(self, request, *args, format=None, **kwargs):  # pylint: disable=redefined-builtin
         entries = []
         for app_name in settings.PLUGINS:
             app_config = apps.get_app_config(app_name)
@@ -237,11 +233,11 @@ class MarketplaceView(GenericView):
 
         installed_apps = [app for app in apps.get_app_configs() if app.name in settings.PLUGINS]
 
-        # Filter out already installed apps from apps marketplace listing.
-        visible_marketplace_apps = [
-            app
-            for app in marketplace_data["apps"]
-            if all(installed_app.name != app["package_name"] for installed_app in installed_apps)
-        ]
+        # Flag already installed apps
+        for installed_app in installed_apps:
+            for marketplace_app in marketplace_data["apps"]:
+                if installed_app.name == marketplace_app["package_name"]:
+                    marketplace_app["installed"] = True
+                    break
 
-        return render(request, "extras/marketplace.html", {"apps": visible_marketplace_apps})
+        return render(request, "extras/marketplace.html", {"apps": marketplace_data["apps"]})

nautobot/extras/registry.py

@@ -41,7 +41,7 @@ class DatasourceContent:
       weight (int): Defines the order in which datasources will be loaded.
     """
 
-    __slots__ = ["name", "content_identifier", "icon", "callback", "weight"]
+    __slots__ = ["callback", "content_identifier", "icon", "name", "weight"]
 
     def __init__(self, name, content_identifier, icon, callback, weight=1000):
         """Ensure datasource properties."""

nautobot/extras/secrets/__init__.py

@@ -57,10 +57,10 @@ def register_secrets_provider(provider):
 
 
 __all__ = (
-    "register_secrets_provider",
     "SecretError",
     "SecretParametersError",
     "SecretProviderError",
-    "SecretsProvider",
     "SecretValueNotFoundError",
+    "SecretsProvider",
+    "register_secrets_provider",
 )

nautobot/extras/tables.py

@@ -244,7 +244,7 @@ class ConfigContextSchemaValidationStateColumn(tables.Column):
         self.validator = validator
         self.data_field = data_field
 
-    def render(self, record):
+    def render(self, *, record):  # pylint: disable=arguments-differ  # tables2 varies its kwargs
         data = getattr(record, self.data_field)
         try:
             self.validator.validate(data)
@@ -628,13 +628,13 @@ class GitRepositoryTable(BaseTable):
         )
 
     def render_last_sync_time(self, record):
-        if record.name in self.context["job_results"]:
-            return self.context["job_results"][record.name].date_done
+        if record.name in self.context["job_results"]:  # pylint: disable=no-member
+            return self.context["job_results"][record.name].date_done  # pylint: disable=no-member
         return self.default
 
     def render_last_sync_user(self, record):
-        if record.name in self.context["job_results"]:
-            user = self.context["job_results"][record.name].user
+        if record.name in self.context["job_results"]:  # pylint: disable=no-member
+            user = self.context["job_results"][record.name].user  # pylint: disable=no-member
             return user
         return self.default
 
@@ -910,10 +910,12 @@ class JobResultTable(BaseTable):
         """
         return format_html(
             """<label class="label label-default">{}</label>
+            <label class="label label-success">{}</label>
             <label class="label label-info">{}</label>
             <label class="label label-warning">{}</label>
             <label class="label label-danger">{}</label>""",
             record.debug_log_count,
+            record.success_log_count,
             record.info_log_count,
             record.warning_log_count,
             record.error_log_count,

nautobot/extras/templates/extras/dynamicgroup.html

@@ -50,15 +50,7 @@
                 <td>Group Type</td>
                 <td><span>{{ object.get_group_type_display }}</span></td>
             </tr>
-            <tr>
-                <td>Tenant</td>
-                <td>
-                    {% if object.tenant and object.tenant.tenant_group %}
-                        {{ object.tenant.tenant_group|hyperlinked_object }} /
-                    {% endif %}
-                    {{ object.tenant|hyperlinked_object }}
-                </td>
-            </tr>
+            {% include 'inc/tenant_table_row.html' %}
         </table>
     </div>
 {% endblock content_left_page %}

nautobot/extras/templates/extras/job_detail.html

@@ -206,6 +206,22 @@
                     {% endif %}
                 </td>
             </tr>
+            <tr>
+                <td>Is Singleton</td>
+                <td>{{ object.is_singleton | render_boolean }}</td>
+                <td>
+                    {% if object.is_singleton_override %}
+                        <span class="text-muted">
+                            overridden; default is
+                            {% if object.installed %}
+                                {{ object.job_class.is_singleton | render_boolean }}
+                            {% else %}
+                                unknown (not currently installed)
+                            {% endif %}
+                        </span>
+                    {% endif %}
+                </td>
+            </tr>
             <tr>
                 <td>Execution Soft Time Limit</td>
                 <td>

nautobot/extras/templates/extras/job_edit.html

@@ -94,6 +94,7 @@
             {% include "extras/inc/overridable_field.html" with field=form.has_sensitive_variables override_field=form.has_sensitive_variables_override %}
             {% include "extras/inc/overridable_field.html" with field=form.job_queues override_field=form.job_queues_override %}
             {% include "extras/inc/overridable_field.html" with field=form.default_job_queue override_field=form.default_job_queue_override %}
+            {% include "extras/inc/overridable_field.html" with field=form.is_singleton override_field=form.is_singleton_override %}
         </div>
     </div>
     {% include 'inc/extras_features_edit_form_fields.html' %}

nautobot/extras/templates/extras/jobqueue_retrieve.html

@@ -26,15 +26,7 @@
                         {{ object.description|placeholder }}
                     </td>
                 </tr>
-                <tr>
-                    <td>Tenant</td>
-                    <td>
-                        {% if object.tenant and object.tenant.tenant_group %}
-	                    {{ object.tenant.tenant_group|hyperlinked_object }} /
-	                {% endif %}
-	                {{ object.tenant|hyperlinked_object }}
-                    </td>
-                </tr>
+                {% include 'inc/tenant_table_row.html' %}
             </table>
         </div>
 {% endblock %}

nautobot/extras/templates/extras/marketplace.html

@@ -6,6 +6,7 @@
 <style>
     .tile-header {
         display: block;
+        min-height: 85px;  /* allow room for two rows of tags */
     }
 
     .tile-header h2 {
@@ -21,6 +22,7 @@
 
     .tile-description {
         margin-top: 10px;
+        min-height: 72px;  /* allow room for three rows of text */
     }
 
     .tile-actions {
@@ -55,6 +57,16 @@
 {% endblock %}
 
 {% block content %}
+    <div class="row noprint">
+        <div class="col-md-12">
+            <ol class="breadcrumb">
+                {% block breadcrumbs %}
+                    <li><a href="{% url 'apps:apps_marketplace' %}">Apps Marketplace</a></li>
+                {% endblock breadcrumbs %}
+            </ol>
+        </div>
+    </div>
+
     <div class="pull-right noprint">
         <a class="btn btn-primary" href="{% url 'apps:apps_list' %}">See Installed Apps</a>
     </div>
@@ -92,8 +104,11 @@
                             <p class="tile-description">{{ app.headline }}</p>
 
                             <footer class="tile-footer">
-                                <div>Author: {{ app.author }}</div>
-                                <div>Availability: {{ app.availability }}</div>
+                                <div>By: {{ app.author }}</div>
+                                <div>
+                                    {% if app.installed %}<label class="label label-success">Installed</label>{% endif %}
+                                    <label class="label label-transparent">{{ app.availability }}</label>
+                                </div>
                             </footer>
                         </a>
 
@@ -121,7 +136,10 @@
                                         <span aria-hidden="true">&times;</span>
                                     </button>
 
-                                    <h4 class="modal-title">{{ app.name }}</h4>
+                                    <h4 class="modal-title">
+                                        {{ app.name }}
+                                        {% if app.installed %}<label class="label label-success">Installed</label>{% endif %}
+                                    </h4>
                                 </div>
 
                                 <div class="modal-body">
@@ -135,11 +153,11 @@
                                             />
 
                                             <dl>
-                                                <dt class="text-muted text-uppercase">Author</dt>
+                                                <dt class="text-muted text-uppercase">By</dt>
                                                 <dd>{{ app.author }}</dd>
 
-                                                <dt class="text-muted text-uppercase">Availability</dt>
-                                                <dd>{{ app.availability }}</dd>
+                                                <dt class="text-muted text-uppercase">License</dt>
+                                                <dd><label class="label label-transparent">{{ app.availability }}</label></dd>
 
                                                 {% if app.requires|length > 0 %}
                                                     <dt class="text-muted text-uppercase">Requirements</dt>
@@ -171,7 +189,7 @@
                                         <div>
                                             <h5>{{ app.headline }}</h5>
 
-                                            <p>{{ app.description }}</p>
+                                            <p>{{ app.description|render_markdown }}</p>
 
                                             {% if app.docs|default:None != None %}
                                                 <p>
@@ -182,12 +200,12 @@
                                                 </p>
                                             {% endif %}
 
-                                            {% if app.availability == "Private" %}
+                                            {% if app.availability == "NTC License" %}
                                                 <p>
                                                     <strong>
-                                                        This app is private. Reach out to
-                                                        <a href="https://networktocode.com/nautobot/" target="_blank">
-                                                            Nautobot Team
+                                                        This Nautobot App requires a license to use.
+                                                        <a href="https://networktocode.com/contact/" target="_blank">
+                                                            Reach out to Network to Code
                                                         </a>
                                                         for more information.
                                                     </strong>

nautobot/extras/templates/extras/plugin_detail.html

@@ -7,27 +7,32 @@
             <ol class="breadcrumb">
                 {% block breadcrumbs %}
                     <li><a href="{% url 'apps:apps_list' %}">Installed Apps</a></li>
-                    <li><a href="{% url 'apps:app_detail' app=object.name %}">{{ object.verbose_name | bettertitle }}</a></li>
+                    <li><a href="{% url 'apps:app_detail' app=app_data.package %}">{{ app_data.name | bettertitle }}</a></li>
                 {% endblock breadcrumbs %}
             </ol>
         </div>
     </div>
     <div class="pull-right noprint">
         {% block buttons %}
-            {% if object.home_view_name %}
-                <a href="{% url object.home_view_name %}" class="btn btn-success">
+            {% if app_data.home_url %}
+                <a href="{% url app_data.home_url %}" class="btn btn-primary">
                     <i class="mdi mdi-home"></i> App Home
                 </a>
             {% endif %}
-            {% if object.config_view_name %}
-                <a href="{% url object.config_view_name %}" class="btn btn-warning">
+            {% if app_data.config_url %}
+                <a href="{% url app_data.config_url %}" class="btn btn-warning">
                     <i class="mdi mdi-cog"></i> App Configuration
                 </a>
             {% endif %}
+            {% if app_data.docs_url %}
+                <a href="{% url app_data.docs_url %}" class="btn btn-info">
+                    <i class="mdi mdi-cog"></i> App Documentation
+                </a>
+            {% endif %}
         {% endblock buttons %}
     </div>
     {% block masthead %}
-        <h1>{% block title %}{{ object.verbose_name | bettertitle }}{% endblock %}</h1>
+        <h1>{% block title %}{{ app_data.name | bettertitle }}{% endblock %}</h1>
     {% endblock masthead %}
 {% endblock header %}
 
@@ -42,25 +47,37 @@
                     <table class="table table-hover panel-body attr-table">
                         <tr>
                             <td>Package Name</td>
-                            <td><code>{{ object.name }}</code></td>
+                            <td><code>{{ app_data.package }}</code></td>
+                        </tr>
+                        <tr>
+                            <td>Headline</td>
+                            <td>{{ app_data.headline }}</td>
                         </tr>
+                        {% if app_data.description and app_data.headline != app_data.description %}
                         <tr>
                             <td>Description</td>
-                            <td>{{ object.description }}</td>
+                            <td>{{ app_data.description }}</td>
                         </tr>
+                        {% endif %}
                         <tr>
                             <td>Version</td>
-                            <td>{{ object.version }}</td>
+                            <td>v{{ app_data.version }}</td>
                         </tr>
                         <tr>
-                            <td>Author</td>
+                            <td>By</td>
                             <td>
-                                {{ object.author | placeholder }}
-                                {% if object.author_email %}
-                                    (<a href="mailto:{{ object.author_email }}">{{ object.author_email }}</a>)
+                                {{ app_data.author | placeholder }}
+                                {% if app_data.author_email %}
+                                    (<a href="mailto:{{ app_data.author_email }}">{{ app_data.author_email }}</a>)
                                 {% endif %}
                             </td>
                         </tr>
+                        {% if app_data.availability %}
+                        <tr>
+                            <td>License</td>
+                            <td><label class="label label-transparent">{{ app_data.availability }}</label></td>
+                        </tr>
+                        {% endif %}
                     </table>
                 </div>
                 <div class="panel panel-default">
@@ -70,11 +87,11 @@
                     <table class="table table-hover panel-body attr-table">
                         <tr>
                             <td>Min Nautobot Version</td>
-                            <td>{{ object.min_version | placeholder }}</td>
+                            <td>v{{ object.min_version | placeholder }}</td>
                         </tr>
                         <tr>
                             <td>Max Nautobot Version</td>
-                            <td>{{ object.max_version | placeholder }}</td>
+                            <td>v{{ object.max_version | placeholder }}</td>
                         </tr>
                     </table>
                 </div>

nautobot/extras/templates/extras/plugins_tiles.html

@@ -9,6 +9,7 @@
     }
 
     .tile-header h2 {
+        margin-bottom: 5px;
         margin-top: 0;
     }
 
@@ -17,6 +18,11 @@
         margin-left: 3px;
     }
 
+    .tile-description {
+        margin-top: 10px;
+        min-height: 72px;  /* allow room for three rows of text */
+    }
+
     .tile-actions {
         position: absolute;
         right: 21px;
@@ -36,7 +42,7 @@
                 <header class="tile-header">
                     <img
                         alt="{{ row.record.name }}"
-                        src="{% if app_icons|get_item:row.record.package_name != None %}{{ app_icons|get_item:row.record.package_name }}{% else %}{% static 'img/nautobot_icon_192x192.png' %}{% endif %}"
+                        src="{% if app_icons|get_item:row.record.package != None %}{{ app_icons|get_item:row.record.package }}{% else %}{% static 'img/nautobot_icon_192x192.png' %}{% endif %}"
                         height="64"
                         width="64"
                     />
@@ -45,20 +51,25 @@
                        Occupy `.tile-actions` dedicated space with `.tile-actions-placeholder`. See comment above
                        `.tile-actions` element for detailed explanation of this solution and why it is required here.
                     -->
-                    <div
-                        aria-hidden="true"
-                        class="tile-actions-placeholder pull-right"
-                        style="width: calc(32px * {{ row.record.actions|length }} + 3px * {{ row.record.actions|length|add:-1 }})">
-                    </div>
+                    {% with actions_count=3 %}
+                        <div
+                            aria-hidden="true"
+                            class="tile-actions-placeholder pull-right"
+                            style="width: calc(32px * {{ actions_count }} + 3px * {{ actions_count|add:-1 }})">
+                        </div>
+                    {% endwith %}
 
                     <h2>{{ row.record.name }}</h2>
-
-                    <p class="tile-description">{{ row.record.description }}</p>
                 </header>
 
+                <p class="tile-description">{{ row.record.headline }}</p>
+
                 <footer class="tile-footer">
-                    <div>Author: {{ row.record.author }}</div>
-                    <div>Version: {{ row.record.version }}</div>
+                    <div>By: {{ row.record.author }}</div>
+                    <div>
+                        <label class="label label-transparent">{{ row.record.availability }}</label>
+                        v{{ row.record.version }}
+                    </div>
                 </footer>
             </a>