netbox-contract 2.4.4__tar.gz → 2.4.6__tar.gz

{netbox_contract-2.4.4/netbox_contract.egg-info → netbox_contract-2.4.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: netbox-contract
-Version: 2.4.4
+Version: 2.4.6
 Summary: Contract management plugin for Netbox
 Author-email: Marc Lebreuil <marc@famillelebreuil.net>
 Project-URL: Homepage, https://github.com/mlebreuil/netbox-contract
@@ -49,6 +49,7 @@ Accounting dimensions can be linked with invoice lines.
 |     4.2        |      2.3       |
 |     4.3        |      2.4       |
 |     4.4        |      2.4       |
+|     4.5        |      2.4       |
 
 ## Installing
 
@@ -101,12 +102,17 @@ PLUGINS_CONFIG = {
             'ipam.ipaddress',
             'ipam.prefix',
         ],
+        'contract_assignments_display': 'both',  # options: 'tab', 'inline', 'both'
     }
 }
 
 ```
 
 * top_level_menu : If "Contracts" appears under the "Plugins" menu item or on its own
+* contract_assignments_display:
+  * `'tab'` - only the Contracts view tab is visible on the related object page.
+  * `'inline'` - only the inline contract assignments table is shown in object detail; the Contracts tab is hidden.
+  * `'both'` - both tab and inline table are shown (default behavior).
 * default_accounting_dimensions: The accounting dimensions which will appear in the field' background when empty. Note that accounting dimensions are now managed as individual objects. The use of this field is deprecated.  
 * mandatory_contract_fields, mandatory_invoice_fields: Fields which are not required by default and can be set as such. The list of fields is at the bottom of the contract import form.
 * hidden_contract_fields, hidden_invoice_fields: List of fields to be hidden. Fields should not be required to be hidden.

{netbox_contract-2.4.4 → netbox_contract-2.4.6}/README.md

@@ -22,6 +22,7 @@ Accounting dimensions can be linked with invoice lines.
 |     4.2        |      2.3       |
 |     4.3        |      2.4       |
 |     4.4        |      2.4       |
+|     4.5        |      2.4       |
 
 ## Installing
 
@@ -74,12 +75,17 @@ PLUGINS_CONFIG = {
             'ipam.ipaddress',
             'ipam.prefix',
         ],
+        'contract_assignments_display': 'both',  # options: 'tab', 'inline', 'both'
     }
 }
 
 ```
 
 * top_level_menu : If "Contracts" appears under the "Plugins" menu item or on its own
+* contract_assignments_display:
+  * `'tab'` - only the Contracts view tab is visible on the related object page.
+  * `'inline'` - only the inline contract assignments table is shown in object detail; the Contracts tab is hidden.
+  * `'both'` - both tab and inline table are shown (default behavior).
 * default_accounting_dimensions: The accounting dimensions which will appear in the field' background when empty. Note that accounting dimensions are now managed as individual objects. The use of this field is deprecated.  
 * mandatory_contract_fields, mandatory_invoice_fields: Fields which are not required by default and can be set as such. The list of fields is at the bottom of the contract import form.
 * hidden_contract_fields, hidden_invoice_fields: List of fields to be hidden. Fields should not be required to be hidden.

{netbox_contract-2.4.4 → netbox_contract-2.4.6}/netbox_contract/__init__.py

@@ -5,11 +5,11 @@ class ContractsConfig(PluginConfig):
     name = 'netbox_contract'
     verbose_name = 'Netbox contract'
     description = 'Contract management plugin for Netbox'
-    version = '2.4.4'
+    version = '2.4.6'
     author = 'Marc Lebreuil'
     author_email = 'marc@famillelebreuil.net'
     base_url = 'contracts'
-    min_version = '4.3.0'
+    min_version = '4.5.0'
     required_settings = []
     default_settings = {
         'top_level_menu': False,
@@ -27,6 +27,7 @@ class ContractsConfig(PluginConfig):
             'virtualization.virtualmachine',
             'virtualization.cluster',
         ],
+        'contract_assignments_display': 'both',  # options: 'tab', 'inline', 'both'
     }
 
 

{netbox_contract-2.4.4 → netbox_contract-2.4.6}/netbox_contract/api/serializers.py

@@ -46,12 +46,14 @@ class NestedContractSerializer(WritableNestedSerializer):
             'end_date',
             'initial_term',
             'renewal_term',
+            'notice_period',
             'currency',
             'mrc',
             'yrc',
             'nrc',
             'invoice_frequency',
             'comments',
+            'documents',
         )
 
     @swagger_serializer_method(serializer_or_field=serializers.JSONField)
@@ -98,6 +100,7 @@ class ContractTypeSerializer(NetBoxModelSerializer):
             'display',
             'name',
             'description',
+            'color',
             'tags',
             'custom_fields',
             'created',
@@ -136,12 +139,14 @@ class ContractSerializer(NetBoxModelSerializer):
             'end_date',
             'initial_term',
             'renewal_term',
+            'notice_period',
             'currency',
             'mrc',
             'yrc',
             'nrc',
             'invoice_frequency',
             'comments',
+            'documents',
             'parent',
             'tags',
             'custom_fields',
@@ -205,12 +210,14 @@ class InvoiceSerializer(NetBoxModelSerializer):
             'number',
             'date',
             'template',
+            'status',
             'contracts',
             'period_start',
             'period_end',
             'currency',
             'amount',
             'comments',
+            'documents',
             'tags',
             'custom_fields',
             'created',
@@ -310,13 +317,15 @@ class ServiceProviderSerializer(NetBoxModelSerializer):
             'url',
             'display',
             'name',
+            'slug',
             'portal_url',
+            'comments',
             'tags',
             'custom_fields',
             'created',
             'last_updated',
         )
-        brief_fields = ('id', 'url', 'display', 'name')
+        brief_fields = ('id', 'url', 'display', 'name', 'slug')
 
 
 class ContractAssignmentSerializer(NetBoxModelSerializer):
@@ -337,10 +346,12 @@ class ContractAssignmentSerializer(NetBoxModelSerializer):
             'object_id',
             'content_object',
             'contract',
+            'tags',
+            'custom_fields',
             'created',
             'last_updated',
         )
-        brief_fields = ('id', 'url', 'display', 'content_object', 'contract')
+        brief_fields = ('id', 'url', 'display', 'content_object', 'contract', 'tags', 'custom_fields')
 
     @swagger_serializer_method(serializer_or_field=serializers.JSONField)
     def get_content_object(self, instance):
@@ -394,8 +405,7 @@ class InvoiceLineSerializer(NetBoxModelSerializer):
         for dimension in accounting_dimensions:
             if dimension.name in dimensions_names:
                 raise serializers.ValidationError('duplicate accounting dimension')
-            else:
-                dimensions_names.append(dimension.name)
+            dimensions_names.append(dimension.name)
         return data
 
 
@@ -412,6 +422,7 @@ class AccountingDimensionSerializer(NetBoxModelSerializer):
             'display',
             'name',
             'value',
+            'status',
             'comments',
             'tags',
             'custom_fields',

{netbox_contract-2.4.4 → netbox_contract-2.4.6}/netbox_contract/forms.py

@@ -1,3 +1,4 @@
+from circuits.models import Provider
 from django import forms
 from django.conf import settings
 from django.contrib.contenttypes.models import ContentType
@@ -11,7 +12,6 @@ from netbox.forms import (
 )
 from tenancy.forms import ContactModelFilterForm, TenancyFilterForm
 from tenancy.models import Tenant
-from circuits.models import Provider
 from utilities.forms import BOOLEAN_WITH_BLANK_CHOICES, get_field_value
 from utilities.forms.fields import (
     ColorField,
@@ -40,9 +40,9 @@ from .models import (
     InternalEntityChoices,
     Invoice,
     InvoiceLine,
+    InvoiceStatusChoices,
     ServiceProvider,
     StatusChoices,
-    InvoiceStatusChoices,
 )
 
 plugin_settings = settings.PLUGINS_CONFIG['netbox_contract']
@@ -61,6 +61,11 @@ class ContractForm(NetBoxModelForm):
         label=_('External party object type'),
     )
     external_party_object = forms.ModelChoiceField(queryset=None, label=_('External party object'))
+    internal_party = internal_party = forms.ChoiceField(
+        choices=InternalEntityChoices,
+        required=True,
+        label=_('Internal party')
+    )
     tenant = DynamicModelChoiceField(queryset=Tenant.objects.all(), required=False, selector=True, label=_('Tenant'))
     parent = DynamicModelChoiceField(
         queryset=Contract.objects.all(),
@@ -683,8 +688,7 @@ class InvoiceLineForm(NetBoxModelForm):
         for dimension in accounting_dimensions:
             if dimension.name in dimensions_names:
                 raise ValidationError('duplicate accounting dimension')
-            else:
-                dimensions_names.append(dimension.name)
+            dimensions_names.append(dimension.name)
 
         # Make sure mandatory dimensions are present
         mandatory_dimensions = plugin_settings.get('mandatory_dimensions')

netbox_contract-2.4.6/netbox_contract/template_content.py

@@ -0,0 +1,45 @@
+from django.conf import settings
+from django.contrib.contenttypes.models import ContentType
+from netbox.plugins import PluginTemplateExtension
+
+from . import tables
+from .constants import ASSIGNEMENT_TYPES
+from .models import ContractAssignment
+
+
+class ObjectContractAssignments(PluginTemplateExtension):
+    models = ASSIGNEMENT_TYPES
+
+    def full_width_page(self):
+        display = settings.PLUGINS_CONFIG.get('netbox_contract', {}).get(
+            'contract_assignments_display', 'both'
+        )
+
+        # 'tab' means only the contract tab is shown; inline table stays hidden.
+        if display == 'tab':
+            return ''
+
+        # 'inline' or 'both' renders inline table; the tab is still built via ObjectChildrenView.
+        if display in ('inline', 'both'):
+            object = self.context['object']
+            object_type = ContentType.objects.get_for_model(object)
+
+            contract_assignments = ContractAssignment.objects.filter(
+                content_type__pk=object_type.id, object_id=object.id
+            )
+            assignments_table = tables.ContractAssignmentObjectTable(contract_assignments)
+            assignments_table.configure(self.context['request'])
+
+            return self.render(
+                'contract_assignments_bottom.html',
+                extra_context={
+                    'assignments_table': assignments_table,
+                },
+            )
+
+        return ''
+
+
+template_extensions = [
+    ObjectContractAssignments,
+]

{netbox_contract-2.4.4 → netbox_contract-2.4.6}/netbox_contract/templates/netbox_contract/contract.html

@@ -42,7 +42,7 @@
             </tr>
             <tr>
               <th scope="row">{% trans "Internal party" %}</th>
-              <td>{{ object.internal_party }}</td>
+              <td>{{ object.get_internal_party_display }}</td>
             </tr>
             {% if not 'tenant' in hidden_fields %}
             <tr>

netbox_contract-2.4.6/netbox_contract/templates/netbox_contract/object_contracts.html

@@ -0,0 +1,7 @@
+{% extends 'generic/object_children.html' %}
+{% load buttons %}
+
+{% block table_controls %}
+    {# Only the page header action button is needed (avoid duplicate table button) #}
+    {{ block.super }}
+{% endblock table_controls %}

{netbox_contract-2.4.4 → netbox_contract-2.4.6}/netbox_contract/views.py

@@ -1,19 +1,23 @@
 from datetime import date, timedelta
 
 from dateutil.relativedelta import relativedelta
+from django.apps import apps
 from django.conf import settings
 from django.contrib.contenttypes.models import ContentType
 from django.core.exceptions import ObjectDoesNotExist
 from django.db.models import Case, F, When
 from django.db.models.functions import Round
 from django.shortcuts import get_object_or_404, render
+from django.utils.translation import gettext_lazy as _
+from netbox.object_actions import *
 from netbox.views import generic
 from netbox.views.generic.utils import get_prerequisite_model
 from utilities.forms import restrict_form_fields
 from utilities.querydict import normalize_querydict
-from utilities.views import register_model_view
+from utilities.views import ViewTab, get_action_url, register_model_view
 
 from . import filtersets, forms, tables
+from .constants import ASSIGNEMENT_TYPES
 from .models import (
     AccountingDimension,
     Contract,
@@ -182,6 +186,66 @@ class ContractAssignmentBulkDeleteView(generic.BulkDeleteView):
     filterset = filtersets.ContractAssignmentFilterSet
     table = tables.ContractAssignmentListTable
 
+
+class AddContractAssignment(AddObject):
+    label = _('Add contract')
+
+    @classmethod
+    def get_url(cls, obj):
+        # obj will be the parent object in the custom template (ObjectChildren hook)
+        if hasattr(obj, 'pk') and hasattr(obj, '_meta') and obj.pk:
+            parent = obj
+            parent_ct = ContentType.objects.get_for_model(parent)
+            base_url = get_action_url(ContractAssignment, action='add')
+            return (
+                f"{base_url}?content_type={parent_ct.pk}"
+                f"&object_id={parent.pk}&return_url={parent.get_absolute_url()}"
+            )
+
+        # fallback for a class value (if called as model class)
+        return get_action_url(ContractAssignment, action='add')
+
+
+class BaseObjectContractAssignmentView(generic.ObjectChildrenView):
+    child_model = ContractAssignment
+    table = tables.ContractAssignmentObjectTable
+    filterset = filtersets.ContractAssignmentFilterSet
+    template_name = 'netbox_contract/object_contracts.html'
+    actions = (AddContractAssignment, BulkEdit, BulkDelete)
+    tab = ViewTab(
+        label=_('Contracts'),
+        visible=lambda obj: plugin_settings.get('contract_assignments_display', 'both') != 'inline',
+        badge=lambda obj: ContractAssignment.objects.filter(
+            content_type=ContentType.objects.get_for_model(obj), object_id=obj.id
+        ).count(),
+        permission='contracts.view_contractassignment',
+        weight=550,
+        hide_if_empty=True,
+    )
+
+    def get_children(self, request, parent):
+        object_type = ContentType.objects.get_for_model(parent)
+        contract_assignments = ContractAssignment.objects.filter(
+            content_type__pk=object_type.id, object_id=parent.id
+        )
+        return contract_assignments
+
+
+# Dynamically register the view for all supported models
+for model_string in ASSIGNEMENT_TYPES:
+    app_label, model_name = model_string.split('.')
+    model = apps.get_model(app_label, model_name)
+
+    class_name = f"{model_name.title()}ContractAssignmentView"
+    attrs = {
+        'queryset': model.objects.all(),
+        'viewname': f'netbox_contract:{model_name}_contracts',
+    }
+    view_class = type(class_name, (BaseObjectContractAssignmentView,), attrs)
+
+    register_model_view(model, 'contracts', path='contracts')(view_class)
+
+
 # Contract views
 
 

{netbox_contract-2.4.4 → netbox_contract-2.4.6/netbox_contract.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: netbox-contract
-Version: 2.4.4
+Version: 2.4.6
 Summary: Contract management plugin for Netbox
 Author-email: Marc Lebreuil <marc@famillelebreuil.net>
 Project-URL: Homepage, https://github.com/mlebreuil/netbox-contract
@@ -49,6 +49,7 @@ Accounting dimensions can be linked with invoice lines.
 |     4.2        |      2.3       |
 |     4.3        |      2.4       |
 |     4.4        |      2.4       |
+|     4.5        |      2.4       |
 
 ## Installing
 
@@ -101,12 +102,17 @@ PLUGINS_CONFIG = {
             'ipam.ipaddress',
             'ipam.prefix',
         ],
+        'contract_assignments_display': 'both',  # options: 'tab', 'inline', 'both'
     }
 }
 
 ```
 
 * top_level_menu : If "Contracts" appears under the "Plugins" menu item or on its own
+* contract_assignments_display:
+  * `'tab'` - only the Contracts view tab is visible on the related object page.
+  * `'inline'` - only the inline contract assignments table is shown in object detail; the Contracts tab is hidden.
+  * `'both'` - both tab and inline table are shown (default behavior).
 * default_accounting_dimensions: The accounting dimensions which will appear in the field' background when empty. Note that accounting dimensions are now managed as individual objects. The use of this field is deprecated.  
 * mandatory_contract_fields, mandatory_invoice_fields: Fields which are not required by default and can be set as such. The list of fields is at the bottom of the contract import form.
 * hidden_contract_fields, hidden_invoice_fields: List of fields to be hidden. Fields should not be required to be hidden.

{netbox_contract-2.4.4 → netbox_contract-2.4.6}/netbox_contract.egg-info/SOURCES.txt

@@ -86,4 +86,5 @@ netbox_contract/templates/netbox_contract/contractassignment.html
 netbox_contract/templates/netbox_contract/contracttype.html
 netbox_contract/templates/netbox_contract/invoice.html
 netbox_contract/templates/netbox_contract/invoiceline.html
+netbox_contract/templates/netbox_contract/object_contracts.html
 netbox_contract/templates/netbox_contract/serviceprovider.html

{netbox_contract-2.4.4 → netbox_contract-2.4.6}/pyproject.toml

@@ -7,7 +7,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "netbox-contract"
-version = "2.4.4"
+version = "2.4.6"
 authors = [
   { name="Marc Lebreuil", email="marc@famillelebreuil.net" },
 ]

netbox_contract-2.4.4/netbox_contract/template_content.py

@@ -1,32 +0,0 @@
-from django.contrib.contenttypes.models import ContentType
-from netbox.plugins import PluginTemplateExtension
-
-from . import tables
-from .models import ContractAssignment
-from .constants import ASSIGNEMENT_TYPES
-
-
-class ObjectContractAssignments(PluginTemplateExtension):
-    models = ASSIGNEMENT_TYPES
-
-    def full_width_page(self):
-        object = self.context['object']
-        object_type = ContentType.objects.get_for_model(object)
-
-        contract_assignments = ContractAssignment.objects.filter(
-            content_type__pk=object_type.id, object_id=object.id
-        )
-        assignments_table = tables.ContractAssignmentObjectTable(contract_assignments)
-        assignments_table.configure(self.context['request'])
-
-        return self.render(
-            'contract_assignments_bottom.html',
-            extra_context={
-                'assignments_table': assignments_table,
-            },
-        )
-
-
-template_extensions = [
-    ObjectContractAssignments,
-]

{netbox_contract-2.4.4 → netbox_contract-2.4.6}/netbox_contract/constants.py

@@ -1,5 +1,5 @@
-from django.db.models import Q
 from django.conf import settings
+from django.db.models import Q
 
 plugin_settings = settings.PLUGINS_CONFIG['netbox_contract']
 

{netbox_contract-2.4.4 → netbox_contract-2.4.6}/netbox_contract/filtersets.py

@@ -1,9 +1,9 @@
 import django_filters
-from django.db.models import Q
+from circuits.models import Provider
 from django.contrib.contenttypes.models import ContentType
+from django.db.models import Q
 from netbox.filtersets import NetBoxModelFilterSet
 from tenancy.filtersets import ContactModelFilterSet, TenancyFilterSet
-from circuits.models import Provider
 
 from .models import (
     AccountingDimension,
@@ -15,9 +15,9 @@ from .models import (
     InternalEntityChoices,
     Invoice,
     InvoiceLine,
+    InvoiceStatusChoices,
     ServiceProvider,
     StatusChoices,
-    InvoiceStatusChoices,
 )