netbox-toolkit-plugin 0.1.1__tar.gz → 0.1.3__tar.gz

{netbox_toolkit_plugin-0.1.1 → netbox_toolkit_plugin-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: netbox-toolkit-plugin
-Version: 0.1.1
+Version: 0.1.3
 Summary: NetBox plugin for running pre-defined commands on network devices
 Author: Andy Norwood
 Classifier: Development Status :: 3 - Alpha
@@ -67,7 +67,7 @@ A NetBox plugin that allows you to run commands on network devices directly from
 
 ## Contributing
 
-**🚀 Want to Contribute?** Start with the [Contributor Guide](./docs/contributing.md) for a fast overview of the codebase.
+**🚀 Want to Contribute?** Start with the [Contributor Guide](./docs/development/contributing.md) for a fast overview of the codebase.
 
 
 ## Future ideas:

{netbox_toolkit_plugin-0.1.1 → netbox_toolkit_plugin-0.1.3}/README.md

@@ -46,7 +46,7 @@ A NetBox plugin that allows you to run commands on network devices directly from
 
 ## Contributing
 
-**🚀 Want to Contribute?** Start with the [Contributor Guide](./docs/contributing.md) for a fast overview of the codebase.
+**🚀 Want to Contribute?** Start with the [Contributor Guide](./docs/development/contributing.md) for a fast overview of the codebase.
 
 
 ## Future ideas:

{netbox_toolkit_plugin-0.1.1 → netbox_toolkit_plugin-0.1.3}/netbox_toolkit_plugin/__init__.py

@@ -1,7 +1,7 @@
 from netbox.plugins import PluginConfig
 
 __author__ = "Andy Norwood"
-__version__ = "0.1.1"
+__version__ = "0.1.3"
 
 
 class ToolkitPluginConfig(PluginConfig):

netbox_toolkit_plugin-0.1.3/netbox_toolkit_plugin/admin.py

@@ -0,0 +1,20 @@
+from django.contrib import admin
+
+from netbox.admin import NetBoxModelAdmin
+
+from .models import Command, CommandLog
+
+
+@admin.register(Command)
+class CommandAdmin(NetBoxModelAdmin):
+    list_display = ("name", "platform", "command_type", "description")
+    list_filter = ("platform", "command_type")
+    search_fields = ("name", "command", "description")
+
+
+@admin.register(CommandLog)
+class CommandLogAdmin(NetBoxModelAdmin):
+    list_display = ("command", "device", "username", "execution_time")
+    list_filter = ("command", "device", "username", "execution_time")
+    search_fields = ("command__name", "device__name", "username", "output")
+    readonly_fields = ("output", "execution_time")

{netbox_toolkit_plugin-0.1.1 → netbox_toolkit_plugin-0.1.3}/netbox_toolkit_plugin/api/mixins.py

@@ -1,54 +1,58 @@
 """
 Common mixins and utilities for NetBox Toolkit API views
 """
-from rest_framework.response import Response
+
 from django.contrib.contenttypes.models import ContentType
+
 from users.models import ObjectPermission
 
 
 class APIResponseMixin:
     """Mixin to add consistent API response headers"""
-    
+
     def finalize_response(self, request, response, *args, **kwargs):
         """Add custom headers to all responses"""
         response = super().finalize_response(request, response, *args, **kwargs)
-        
+
         # Add API version header
-        response['X-NetBox-Toolkit-API-Version'] = '1.0'
-        
+        response["X-NetBox-Toolkit-API-Version"] = "1.0"
+
         return response
 
 
 class PermissionCheckMixin:
     """Mixin for NetBox ObjectPermission checking"""
-    
+
     def _user_has_action_permission(self, user, obj, action):
         """Check if user has permission for a specific action on an object using NetBox's ObjectPermission system"""
         # Get content type for the object
         content_type = ContentType.objects.get_for_model(obj)
-        
+
         # Check if user has any ObjectPermissions with the required action
         user_permissions = ObjectPermission.objects.filter(
-            object_types__in=[content_type],
-            actions__contains=[action],
-            enabled=True
+            object_types__in=[content_type], actions__contains=[action], enabled=True
         )
-        
+
         # Check if user is assigned to any groups with this permission
         user_groups = user.groups.all()
         for permission in user_permissions:
             # Check if permission applies to user or user's groups
-            if (permission.users.filter(id=user.id).exists() or 
-                permission.groups.filter(id__in=user_groups.values_list('id', flat=True)).exists()):
-                
+            if (
+                permission.users.filter(id=user.id).exists()
+                or permission.groups.filter(
+                    id__in=user_groups.values_list("id", flat=True)
+                ).exists()
+            ):
                 # If there are constraints, evaluate them
                 if permission.constraints:
                     # Create a queryset with the constraints and check if the object matches
-                    queryset = content_type.model_class().objects.filter(**permission.constraints)
+                    queryset = content_type.model_class().objects.filter(
+                        **permission.constraints
+                    )
                     if queryset.filter(id=obj.id).exists():
                         return True
                 else:
                     # No constraints means permission applies to all objects of this type
                     return True
-        
+
         return False

{netbox_toolkit_plugin-0.1.1 → netbox_toolkit_plugin-0.1.3}/netbox_toolkit_plugin/api/schemas.py

@@ -1,44 +1,40 @@
 """
 OpenAPI schema definitions for NetBox Toolkit API
 """
-from drf_spectacular.utils import extend_schema, OpenApiResponse
 
+from drf_spectacular.utils import OpenApiParameter, OpenApiResponse, extend_schema
 
 # Command ViewSet Schemas
 COMMAND_LIST_SCHEMA = extend_schema(
     summary="List commands",
     description="Retrieve a list of all commands available in the system.",
-    tags=["Commands"]
+    tags=["Commands"],
 )
 
 COMMAND_RETRIEVE_SCHEMA = extend_schema(
     summary="Retrieve command",
     description="Retrieve details of a specific command.",
-    tags=["Commands"]
+    tags=["Commands"],
 )
 
 COMMAND_CREATE_SCHEMA = extend_schema(
-    summary="Create command",
-    description="Create a new command.",
-    tags=["Commands"]
+    summary="Create command", description="Create a new command.", tags=["Commands"]
 )
 
 COMMAND_UPDATE_SCHEMA = extend_schema(
     summary="Update command",
     description="Update an existing command.",
-    tags=["Commands"]
+    tags=["Commands"],
 )
 
 COMMAND_PARTIAL_UPDATE_SCHEMA = extend_schema(
     summary="Partial update command",
     description="Partially update an existing command.",
-    tags=["Commands"]
+    tags=["Commands"],
 )
 
 COMMAND_DESTROY_SCHEMA = extend_schema(
-    summary="Delete command",
-    description="Delete a command.",
-    tags=["Commands"]
+    summary="Delete command", description="Delete a command.", tags=["Commands"]
 )
 
 COMMAND_EXECUTE_SCHEMA = extend_schema(
@@ -57,36 +53,25 @@ COMMAND_EXECUTE_SCHEMA = extend_schema(
                     "command": {
                         "id": 1,
                         "name": "show interfaces",
-                        "command_type": "show"
-                    },
-                    "device": {
-                        "id": 1,
-                        "name": "switch01.example.com"
-                    },
-                    "syntax_error": {
-                        "detected": False
+                        "command_type": "show",
                     },
+                    "device": {"id": 1, "name": "switch01.example.com"},
+                    "syntax_error": {"detected": False},
                     "parsed_output": {
                         "success": True,
                         "method": "textfsm",
-                        "data": [{"interface": "GigabitEthernet1/0/1", "status": "up"}]
-                    }
+                        "data": [{"interface": "GigabitEthernet1/0/1", "status": "up"}],
+                    },
                 }
-            ]
+            ],
         ),
         400: OpenApiResponse(
             description="Bad request - validation errors or command execution failed"
         ),
-        403: OpenApiResponse(
-            description="Forbidden - insufficient permissions"
-        ),
-        404: OpenApiResponse(
-            description="Not found - command or device not found"
-        ),
-        429: OpenApiResponse(
-            description="Too many requests - rate limit exceeded"
-        )
-    }
+        403: OpenApiResponse(description="Forbidden - insufficient permissions"),
+        404: OpenApiResponse(description="Not found - command or device not found"),
+        429: OpenApiResponse(description="Too many requests - rate limit exceeded"),
+    },
 )
 
 COMMAND_BULK_EXECUTE_SCHEMA = extend_schema(
@@ -104,13 +89,13 @@ COMMAND_BULK_EXECUTE_SCHEMA = extend_schema(
                         "command_id": {"type": "integer"},
                         "device_id": {"type": "integer"},
                         "username": {"type": "string"},
-                        "password": {"type": "string", "format": "password"}
+                        "password": {"type": "string", "format": "password"},
                     },
-                    "required": ["command_id", "device_id", "username", "password"]
-                }
+                    "required": ["command_id", "device_id", "username", "password"],
+                },
             }
         },
-        "required": ["executions"]
+        "required": ["executions"],
     },
     responses={
         200: OpenApiResponse(
@@ -119,54 +104,54 @@ COMMAND_BULK_EXECUTE_SCHEMA = extend_schema(
                 {
                     "results": [
                         {"execution_id": 1, "success": True, "command_log_id": 123},
-                        {"execution_id": 2, "success": False, "error": "Permission denied"}
+                        {
+                            "execution_id": 2,
+                            "success": False,
+                            "error": "Permission denied",
+                        },
                     ],
-                    "summary": {
-                        "total": 2,
-                        "successful": 1,
-                        "failed": 1
-                    }
+                    "summary": {"total": 2, "successful": 1, "failed": 1},
                 }
-            ]
+            ],
         )
-    }
+    },
 )
 
 # Command Log ViewSet Schemas
 COMMAND_LOG_LIST_SCHEMA = extend_schema(
     summary="List command logs",
     description="Retrieve a list of command execution logs with filtering and search capabilities.",
-    tags=["Command Logs"]
+    tags=["Command Logs"],
 )
 
 COMMAND_LOG_RETRIEVE_SCHEMA = extend_schema(
     summary="Retrieve command log",
     description="Retrieve details of a specific command execution log.",
-    tags=["Command Logs"]
+    tags=["Command Logs"],
 )
 
 COMMAND_LOG_CREATE_SCHEMA = extend_schema(
     summary="Create command log",
     description="Create a new command execution log entry.",
-    tags=["Command Logs"]
+    tags=["Command Logs"],
 )
 
 COMMAND_LOG_UPDATE_SCHEMA = extend_schema(
     summary="Update command log",
     description="Update an existing command log entry.",
-    tags=["Command Logs"]
+    tags=["Command Logs"],
 )
 
 COMMAND_LOG_PARTIAL_UPDATE_SCHEMA = extend_schema(
     summary="Partial update command log",
     description="Partially update an existing command log entry.",
-    tags=["Command Logs"]
+    tags=["Command Logs"],
 )
 
 COMMAND_LOG_DESTROY_SCHEMA = extend_schema(
     summary="Delete command log",
     description="Delete a command log entry.",
-    tags=["Command Logs"]
+    tags=["Command Logs"],
 )
 
 COMMAND_LOG_STATISTICS_SCHEMA = extend_schema(
@@ -180,55 +165,49 @@ COMMAND_LOG_STATISTICS_SCHEMA = extend_schema(
                 {
                     "total_logs": 1000,
                     "success_rate": 85.5,
-                    "last_24h": {
-                        "total": 50,
-                        "successful": 45,
-                        "failed": 5
-                    },
+                    "last_24h": {"total": 50, "successful": 45, "failed": 5},
                     "top_commands": [
                         {"command_name": "show interfaces", "count": 150},
-                        {"command_name": "show version", "count": 120}
+                        {"command_name": "show version", "count": 120},
                     ],
                     "common_errors": [
                         {"error": "Connection timeout", "count": 10},
-                        {"error": "Invalid command", "count": 5}
-                    ]
+                        {"error": "Invalid command", "count": 5},
+                    ],
                 }
-            ]
+            ],
         )
-    }
+    },
 )
 
-from drf_spectacular.utils import OpenApiParameter
-
 COMMAND_LOG_EXPORT_SCHEMA = extend_schema(
     summary="Export command logs",
     description="Export command logs in various formats (CSV, JSON).",
     tags=["Command Logs"],
     parameters=[
         OpenApiParameter(
-            name='format',
-            description='Export format',
+            name="format",
+            description="Export format",
             required=False,
             type=str,
-            enum=['csv', 'json'],
-            default='json'
+            enum=["csv", "json"],
+            default="json",
         ),
         OpenApiParameter(
-            name='start_date',
-            description='Start date for export (YYYY-MM-DD)',
+            name="start_date",
+            description="Start date for export (YYYY-MM-DD)",
             required=False,
-            type=str
+            type=str,
         ),
         OpenApiParameter(
-            name='end_date',
-            description='End date for export (YYYY-MM-DD)',
+            name="end_date",
+            description="End date for export (YYYY-MM-DD)",
             required=False,
-            type=str
+            type=str,
         ),
     ],
     responses={
         200: OpenApiResponse(description="Export data"),
-        400: OpenApiResponse(description="Invalid parameters")
-    }
+        400: OpenApiResponse(description="Invalid parameters"),
+    },
 )

{netbox_toolkit_plugin-0.1.1 → netbox_toolkit_plugin-0.1.3}/netbox_toolkit_plugin/api/serializers.py

@@ -1,6 +1,8 @@
-from rest_framework import serializers
+from dcim.api.serializers import DeviceSerializer, PlatformSerializer
 from netbox.api.serializers import NetBoxModelSerializer, WritableNestedSerializer
-from dcim.api.serializers import PlatformSerializer, DeviceSerializer
+
+from rest_framework import serializers
+
 from ..models import Command, CommandLog
 
 
@@ -44,8 +46,8 @@ class CommandExecutionSerializer(serializers.Serializer):
                     "Device must have a primary IP address for command execution"
                 )
             return value
-        except Device.DoesNotExist:
-            raise serializers.ValidationError("Device not found")
+        except Device.DoesNotExist as e:
+            raise serializers.ValidationError("Device not found") from e
 
     def validate(self, data):
         """Cross-field validation and object retrieval"""
@@ -130,9 +132,6 @@ class CommandLogSerializer(NetBoxModelSerializer):
             "success",
             "error_message",
             "execution_duration",
-            "parsed_data",
-            "parsing_success",
-            "parsing_template",
             "created",
             "last_updated",
         )
@@ -176,8 +175,8 @@ class BulkCommandExecutionSerializer(serializers.Serializer):
         try:
             Command.objects.get(id=value)
             return value
-        except Command.DoesNotExist:
-            raise serializers.ValidationError("Command not found")
+        except Command.DoesNotExist as e:
+            raise serializers.ValidationError("Command not found") from e
 
     def validate_device_id(self, value):
         """Validate that the device exists"""
@@ -190,5 +189,5 @@ class BulkCommandExecutionSerializer(serializers.Serializer):
                     "Device must have a platform assigned"
                 )
             return value
-        except Device.DoesNotExist:
-            raise serializers.ValidationError("Device not found")
+        except Device.DoesNotExist as e:
+            raise serializers.ValidationError("Device not found") from e

{netbox_toolkit_plugin-0.1.1 → netbox_toolkit_plugin-0.1.3}/netbox_toolkit_plugin/api/urls.py

@@ -1,5 +1,6 @@
 from netbox.api.routers import NetBoxRouter
-from .views import CommandViewSet, CommandLogViewSet
+
+from .views import CommandLogViewSet, CommandViewSet
 
 app_name = "netbox_toolkit_plugin"
 

{netbox_toolkit_plugin-0.1.1 → netbox_toolkit_plugin-0.1.3}/netbox_toolkit_plugin/api/views/__init__.py

@@ -1,10 +1,11 @@
 """
 Import all viewsets for easier access
 """
-from .commands import CommandViewSet
+
 from .command_logs import CommandLogViewSet
+from .commands import CommandViewSet
 
 __all__ = [
-    'CommandViewSet',
-    'CommandLogViewSet',
+    "CommandViewSet",
+    "CommandLogViewSet",
 ]