netbox-contract 2.2.7__tar.gz → 2.2.10__tar.gz

{netbox_contract-2.2.7/src/netbox_contract.egg-info → netbox_contract-2.2.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: netbox-contract
-Version: 2.2.7
+Version: 2.2.10
 Summary: Contract management plugin for Netbox
 Author-email: Marc Lebreuil <marc@famillelebreuil.net>
 Project-URL: Homepage, https://github.com/mlebreuil/netbox-contract
@@ -73,13 +73,14 @@ PLUGINS_CONFIG = {
 ```
 
 * top_level_menu : If "Contracts" appears under the "Plugins" menu item or on its own
-* default_accounting_dimensions: The accounting dimensions which will appear in the field' background when empty.
+* 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.
 
 ### Customize the plugin fields choices
 
 Internal partie reference the legal entity of your organization that is a partie to the contract.  
+The first currency will also be the default currency for contracts.  
 
 ```python
 # configuration.py

{netbox_contract-2.2.7 → netbox_contract-2.2.10}/README.md

@@ -57,13 +57,14 @@ PLUGINS_CONFIG = {
 ```
 
 * top_level_menu : If "Contracts" appears under the "Plugins" menu item or on its own
-* default_accounting_dimensions: The accounting dimensions which will appear in the field' background when empty.
+* 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.
 
 ### Customize the plugin fields choices
 
 Internal partie reference the legal entity of your organization that is a partie to the contract.  
+The first currency will also be the default currency for contracts.  
 
 ```python
 # configuration.py

{netbox_contract-2.2.7 → netbox_contract-2.2.10}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "netbox-contract"
-version = "2.2.7"
+version = "2.2.10"
 authors = [
   { name="Marc Lebreuil", email="marc@famillelebreuil.net" },
 ]

{netbox_contract-2.2.7 → netbox_contract-2.2.10}/src/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.2.7'
+    version = '2.2.10'
     author = 'Marc Lebreuil'
     author_email = 'marc@famillelebreuil.net'
     base_url = 'contracts'
-    min_version = '4.0.2'
+    min_version = '4.1.10'
     required_settings = []
     default_settings = {
         'top_level_menu': False,

{netbox_contract-2.2.7 → netbox_contract-2.2.10}/src/netbox_contract/forms.py

@@ -2,6 +2,7 @@ from django import forms
 from django.conf import settings
 from django.contrib.contenttypes.models import ContentType
 from django.core.exceptions import ObjectDoesNotExist, ValidationError
+from django.utils.translation import gettext_lazy as _
 from netbox.forms import (
     NetBoxModelBulkEditForm,
     NetBoxModelFilterSetForm,
@@ -42,6 +43,9 @@ from .models import (
 plugin_settings = settings.PLUGINS_CONFIG['netbox_contract']
 default_dimensions = plugin_settings.get('default_accounting_dimensions')
 
+# Dimensions
+# Deprecated. To be removed in version 3.0
+
 
 class Dimensions(JSONField):
     """
@@ -57,17 +61,27 @@ class Dimensions(JSONField):
 
 
 class ContractForm(NetBoxModelForm):
-    comments = CommentField()
+    comments = CommentField(label=_('Comments'))
 
     external_partie_object_type = ContentTypeChoiceField(
         queryset=ContentType.objects.all(),
         limit_choices_to=SERVICE_PROVIDER_MODELS,
         widget=HTMXSelect(),
+        label=_('External partie object type'),
+    )
+    external_partie_object = forms.ModelChoiceField(
+        queryset=None, label=_('External partie object')
+    )
+    tenant = DynamicModelChoiceField(
+        queryset=Tenant.objects.all(), required=False, selector=True, label=_('Tenant')
     )
-    external_partie_object = forms.ModelChoiceField(queryset=None)
-    tenant = DynamicModelChoiceField(queryset=Tenant.objects.all(), required=False)
-    parent = DynamicModelChoiceField(queryset=Contract.objects.all(), required=False)
-    accounting_dimensions = Dimensions(required=False)
+    parent = DynamicModelChoiceField(
+        queryset=Contract.objects.all(),
+        required=False,
+        selector=True,
+        label=_('Parent'),
+    )
+    accounting_dimensions = Dimensions(required=False, label=_('Accounting dimensions'))
 
     def __init__(self, *args, **kwargs):
         initial = kwargs.get('initial', None)
@@ -131,6 +145,7 @@ class ContractForm(NetBoxModelForm):
             'end_date',
             'initial_term',
             'renewal_term',
+            'notice_period',
             'currency',
             'accounting_dimensions',
             'yrc',
@@ -157,15 +172,26 @@ class ContractForm(NetBoxModelForm):
             )
 
 
-class ContractFilterSetForm(NetBoxModelFilterSetForm):
+class ContractFilterForm(NetBoxModelFilterSetForm):
     model = Contract
 
-    tenant = DynamicModelChoiceField(queryset=Tenant.objects.all(), required=False)
-    external_reference = forms.CharField(required=False)
-    internal_partie = forms.ChoiceField(choices=InternalEntityChoices, required=False)
-    status = forms.ChoiceField(choices=StatusChoices, required=False)
-    currency = forms.ChoiceField(choices=CurrencyChoices, required=False)
-    parent = DynamicModelChoiceField(queryset=Contract.objects.all(), required=False)
+    tenant = DynamicModelChoiceField(
+        queryset=Tenant.objects.all(), required=False, selector=True, label=_('Tenant')
+    )
+    external_reference = forms.CharField(required=False, label=_('External reference'))
+    internal_partie = forms.ChoiceField(
+        choices=InternalEntityChoices, required=False, label=_('Internal partie')
+    )
+    status = forms.ChoiceField(choices=StatusChoices, required=False, label=_('Status'))
+    currency = forms.ChoiceField(
+        choices=CurrencyChoices, required=False, label=_('Currency')
+    )
+    parent = DynamicModelChoiceField(
+        queryset=Contract.objects.all(),
+        required=False,
+        selector=True,
+        label=_('Parent'),
+    )
     tag = TagFilterField(model)
 
 
@@ -176,20 +202,24 @@ class ContractCSVForm(NetBoxModelImportForm):
         help_text='service provider object type in the form <app>.<model>',
     )
     external_partie_object_id = forms.CharField(
-        help_text='service provider object name', label='external_partie_name'
+        help_text='service provider object name', label=_('External partie name')
     )
     tenant = CSVModelChoiceField(
         queryset=Tenant.objects.all(),
         to_field_name='name',
         help_text='Tenant name',
         required=False,
+        label=_('Tenant'),
+    )
+    status = CSVChoiceField(
+        choices=StatusChoices, help_text='Contract status', label=_('Status')
     )
-    status = CSVChoiceField(choices=StatusChoices, help_text='Contract status')
     parent = CSVModelChoiceField(
         queryset=Contract.objects.all(),
         to_field_name='name',
         help_text='Contract name',
         required=False,
+        label=_('Parent'),
     )
 
     class Meta:
@@ -230,13 +260,24 @@ class ContractCSVForm(NetBoxModelImportForm):
 
 
 class ContractBulkEditForm(NetBoxModelBulkEditForm):
-    name = forms.CharField(max_length=100, required=False)
-    external_reference = forms.CharField(max_length=100, required=False)
-    internal_partie = forms.ChoiceField(choices=InternalEntityChoices, required=False)
-    tenant = DynamicModelChoiceField(queryset=Tenant.objects.all(), required=False)
-    accounting_dimensions = Dimensions(required=False)
-    comments = CommentField(required=False)
-    parent = DynamicModelChoiceField(queryset=Contract.objects.all(), required=False)
+    name = forms.CharField(max_length=100, required=False, label=_('Name'))
+    external_reference = forms.CharField(
+        max_length=100, required=False, label=_('External reference')
+    )
+    internal_partie = forms.ChoiceField(
+        choices=InternalEntityChoices, required=False, label=_('Internal partie')
+    )
+    tenant = DynamicModelChoiceField(
+        queryset=Tenant.objects.all(), required=False, selector=True, label=_('Tenant')
+    )
+    accounting_dimensions = Dimensions(required=False, label=_('Accounting dimensions'))
+    comments = CommentField(required=False, label=_('Comments'))
+    parent = DynamicModelChoiceField(
+        queryset=Contract.objects.all(),
+        required=False,
+        selector=True,
+        label=_('Parent'),
+    )
 
     nullable_fields = (
         'accounting_dimensions',
@@ -252,11 +293,15 @@ class InvoiceForm(NetBoxModelForm):
     number = forms.CharField(
         max_length=100,
         help_text='Invoice template name will be overriden to _invoice_template_contract name',
+        label=_('Number'),
     )
     contracts = DynamicModelMultipleChoiceField(
-        queryset=Contract.objects.all(), required=False
+        queryset=Contract.objects.all(),
+        required=False,
+        selector=True,
+        label=_('Contracts'),
     )
-    accounting_dimensions = Dimensions(required=False)
+    accounting_dimensions = Dimensions(required=False, label=_('Accounting dimensions'))
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
@@ -360,15 +405,25 @@ class InvoiceForm(NetBoxModelForm):
         }
 
 
-class InvoiceFilterSetForm(NetBoxModelFilterSetForm):
+class InvoiceFilterForm(NetBoxModelFilterSetForm):
     model = Invoice
-    number = forms.CharField(required=False)
+    number = forms.CharField(
+        required=False,
+        label=_('Number'),
+    )
     template = forms.NullBooleanField(
-        required=False, widget=forms.Select(choices=BOOLEAN_WITH_BLANK_CHOICES)
+        required=False,
+        widget=forms.Select(choices=BOOLEAN_WITH_BLANK_CHOICES),
+        label=_('Template'),
+    )
+    currency = forms.ChoiceField(
+        choices=CurrencyChoices, required=False, label=_('Currency')
     )
-    currency = forms.ChoiceField(choices=CurrencyChoices, required=False)
     contracts = DynamicModelMultipleChoiceField(
-        queryset=Contract.objects.all(), required=False
+        queryset=Contract.objects.all(),
+        required=False,
+        selector=True,
+        label=_('Contracts'),
     )
     tag = TagFilterField(model)
 
@@ -378,6 +433,7 @@ class InvoiceCSVForm(NetBoxModelImportForm):
         queryset=Contract.objects.all(),
         to_field_name='name',
         help_text='Related Contracts',
+        label=_('Contracts'),
     )
 
     class Meta:
@@ -399,19 +455,52 @@ class InvoiceCSVForm(NetBoxModelImportForm):
 
 
 class InvoiceBulkEditForm(NetBoxModelBulkEditForm):
-    number = forms.CharField(max_length=100, required=True)
-    template = forms.BooleanField(required=False)
-    date = forms.DateField(required=False)
+    number = forms.CharField(max_length=100, required=True, label=_('Number'))
+    template = forms.BooleanField(
+        required=False,
+        label=_('Template'),
+        help_text=_('Wether this invoice is a template or not'),
+    )
+    date = forms.DateField(
+        required=False,
+        label=_('Date'),
+    )
     contracts = DynamicModelMultipleChoiceField(
-        queryset=Contract.objects.all(), required=False
-    )
-    period_start = forms.DateField(required=False)
-    period_end = forms.DateField(required=False)
-    currency = forms.ChoiceField(choices=CurrencyChoices, required=False)
-    accounting_dimensions = Dimensions(required=False)
-    amount = forms.DecimalField(max_digits=10, decimal_places=2, required=False)
-    documents = forms.URLField(required=False)
-    comments = CommentField()
+        queryset=Contract.objects.all(),
+        required=False,
+        selector=True,
+    )
+    period_start = forms.DateField(
+        required=False,
+        label=_('Period start'),
+    )
+    period_end = forms.DateField(
+        required=False,
+        label=_('Period end'),
+    )
+    currency = forms.ChoiceField(
+        choices=CurrencyChoices,
+        required=False,
+        label=_('Currency'),
+    )
+    accounting_dimensions = Dimensions(
+        required=False,
+        label=_('Accounting dimensions'),
+    )
+    amount = forms.DecimalField(
+        max_digits=10,
+        decimal_places=2,
+        required=False,
+        label=_('Amount'),
+    )
+    documents = forms.URLField(
+        required=False,
+        label=_('Documents'),
+        help_text=_('URL to the contract documents'),
+    )
+    comments = CommentField(
+        label=_('Comments'),
+    )
     nullable_fields = (
         'accounting_dimensions',
         'comments',
@@ -424,23 +513,23 @@ class InvoiceBulkEditForm(NetBoxModelBulkEditForm):
 
 
 class ServiceProviderForm(NetBoxModelForm):
-    slug = SlugField()
-    comments = CommentField()
+    slug = SlugField(label=_('Slug'))
+    comments = CommentField(label=_('Comments'))
 
     class Meta:
         model = ServiceProvider
         fields = ('name', 'slug', 'portal_url', 'comments', 'tags')
 
 
-class ServiceProviderFilterSetForm(NetBoxModelFilterSetForm):
+class ServiceProviderFilterForm(NetBoxModelFilterSetForm):
     model = ServiceProvider
-    name = forms.CharField(required=False)
+    name = forms.CharField(required=False, label=_('Name'))
     tag = TagFilterField(model)
 
 
 class ServiceProviderCSVForm(NetBoxModelImportForm):
-    slug = SlugField()
-    comments = CommentField()
+    slug = SlugField(label=_('Slug'))
+    comments = CommentField(label=_('Comments'))
 
     class Meta:
         model = ServiceProvider
@@ -448,8 +537,8 @@ class ServiceProviderCSVForm(NetBoxModelImportForm):
 
 
 class ServiceProviderBulkEditForm(NetBoxModelBulkEditForm):
-    name = forms.CharField(max_length=100, required=True)
-    comments = CommentField()
+    name = forms.CharField(max_length=100, required=True, label=_('Name'))
+    comments = CommentField(label=_('Comments'))
     nullable_fields = ('comments',)
     model = ServiceProvider
 
@@ -458,7 +547,9 @@ class ServiceProviderBulkEditForm(NetBoxModelBulkEditForm):
 
 
 class ContractAssignmentForm(NetBoxModelForm):
-    contract = DynamicModelChoiceField(queryset=Contract.objects.all())
+    contract = DynamicModelChoiceField(
+        queryset=Contract.objects.all(), selector=True, label=_('Contract')
+    )
 
     class Meta:
         model = ContractAssignment
@@ -469,18 +560,25 @@ class ContractAssignmentForm(NetBoxModelForm):
         }
 
 
-class ContractAssignmentFilterSetForm(NetBoxModelFilterSetForm):
+class ContractAssignmentFilterForm(NetBoxModelFilterSetForm):
     model = ContractAssignment
-    contract = DynamicModelChoiceField(queryset=Contract.objects.all())
+    contract = DynamicModelChoiceField(
+        queryset=Contract.objects.all(),
+        selector=True,
+        label=_('Contract'),
+    )
 
 
 class ContractAssignmentImportForm(NetBoxModelImportForm):
     content_type = CSVContentTypeField(
         queryset=ContentType.objects.all(),
         help_text='Content Type in the form <app>.<model>',
+        label=_('Content type'),
     )
     contract = CSVModelChoiceField(
-        queryset=Contract.objects.all(), help_text='Contract id'
+        queryset=Contract.objects.all(),
+        help_text='Contract id',
+        label=_('Contract'),
     )
 
     class Meta:
@@ -492,9 +590,16 @@ class ContractAssignmentImportForm(NetBoxModelImportForm):
 
 
 class InvoiceLineForm(NetBoxModelForm):
-    invoice = DynamicModelChoiceField(queryset=Invoice.objects.all())
+    invoice = DynamicModelChoiceField(
+        queryset=Invoice.objects.all(),
+        selector=True,
+        label=_('Invoice'),
+    )
     accounting_dimensions = DynamicModelMultipleChoiceField(
-        queryset=AccountingDimension.objects.all(), required=False
+        queryset=AccountingDimension.objects.all(),
+        required=False,
+        selector=True,
+        label=_('Accounting dimensions'),
     )
 
     def clean(self):
@@ -527,13 +632,25 @@ class InvoiceLineForm(NetBoxModelForm):
         ]
 
 
-class InvoiceLineFilterSetForm(NetBoxModelFilterSetForm):
+class InvoiceLineFilterForm(NetBoxModelFilterSetForm):
     model = InvoiceLine
-    invoice = DynamicModelChoiceField(queryset=Invoice.objects.all(), required=False)
+    invoice = DynamicModelChoiceField(
+        queryset=Invoice.objects.all(),
+        required=False,
+        selector=True,
+        label=_('Invoice'),
+    )
     accounting_dimensions = DynamicModelMultipleChoiceField(
-        queryset=AccountingDimension.objects.all(), required=False
+        queryset=AccountingDimension.objects.all(),
+        required=False,
+        selector=True,
+        label=_('Accounting dimensions'),
+    )
+    currency = forms.ChoiceField(
+        choices=CurrencyChoices,
+        required=False,
+        label=_('Currency'),
     )
-    currency = forms.ChoiceField(choices=CurrencyChoices, required=False)
     tag = TagFilterField(model)
 
 
@@ -542,11 +659,13 @@ class InvoiceLineImportForm(NetBoxModelImportForm):
         queryset=Invoice.objects.all(),
         to_field_name='number',
         help_text='Invoice number',
+        label=_('Invoice'),
     )
     accounting_dimensions = CSVModelMultipleChoiceField(
         queryset=AccountingDimension.objects.all(),
         to_field_name='id',
         help_text='accounting dimension id',
+        label=_('Accounting dimensions'),
     )
 
     class Meta:
@@ -564,7 +683,10 @@ class InvoiceLineImportForm(NetBoxModelImportForm):
 class InvoiceLineBulkEditForm(NetBoxModelBulkEditForm):
     invoice = DynamicModelChoiceField(queryset=Invoice.objects.all(), required=False)
     accounting_dimensions = DynamicModelMultipleChoiceField(
-        queryset=AccountingDimension.objects.all(), required=False
+        queryset=AccountingDimension.objects.all(),
+        required=False,
+        selector=True,
+        label=_('Accounting dimensions'),
     )
     model = InvoiceLine
 
@@ -584,12 +706,16 @@ class AccountingDimensionForm(NetBoxModelForm):
         ]
 
 
-class AccountingDimensionFilterSetForm(NetBoxModelFilterSetForm):
+class AccountingDimensionFilterForm(NetBoxModelFilterSetForm):
     model = AccountingDimension
 
-    name = forms.CharField(required=False)
-    value = forms.CharField(required=False)
-    status = forms.ChoiceField(choices=AccountingDimensionStatusChoices, required=False)
+    name = forms.CharField(required=False, label=_('Name'))
+    value = forms.CharField(required=False, label=_('Value'))
+    status = forms.ChoiceField(
+        choices=AccountingDimensionStatusChoices,
+        required=False,
+        label=_('Status'),
+    )
 
 
 class AccountingDimensionImportForm(NetBoxModelImportForm):
@@ -607,6 +733,6 @@ class AccountingDimensionImportForm(NetBoxModelImportForm):
 
 
 class AccountingDimensionBulkEditForm(NetBoxModelBulkEditForm):
-    name = forms.CharField(max_length=20, required=False)
-    value = forms.CharField(max_length=20, required=False)
+    name = forms.CharField(max_length=20, required=False, label=_('Name'))
+    value = forms.CharField(max_length=20, required=False, label=_('Value'))
     model = AccountingDimension

netbox_contract-2.2.10/src/netbox_contract/migrations/0037_contract_notice_period_alter_contract_currency_and_more.py

@@ -0,0 +1,32 @@
+# Generated by Django 5.0.10 on 2025-01-03 19:52
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ('netbox_contract', '0036_alter_invoiceline_accounting_dimensions'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='contract',
+            name='notice_period',
+            field=models.IntegerField(default=90),
+        ),
+        migrations.AlterField(
+            model_name='contract',
+            name='currency',
+            field=models.CharField(default='eur', max_length=3),
+        ),
+        migrations.AlterField(
+            model_name='invoice',
+            name='currency',
+            field=models.CharField(default='eur', max_length=3),
+        ),
+        migrations.AlterField(
+            model_name='invoiceline',
+            name='currency',
+            field=models.CharField(default='eur', max_length=3),
+        ),
+    ]