netbox-contract 2.3.1__tar.gz → 2.3.2__tar.gz

{netbox_contract-2.3.1 → netbox_contract-2.3.2}/CONTRIBUTING.md

@@ -20,20 +20,18 @@ and "help wanted" is open to whoever wants to implement it.
 
 ## Coding conventions
  
-Netbox [Style Guide](https://docs.netbox.dev/en/stable/development/style-guide/)  
-Django [Coding style](https://docs.djangoproject.com/en/4.2/internals/contributing/writing-code/coding-style/)  
+Netbox [Style Guide](https://netboxlabs.com/docs/netbox/en/stable/development/style-guide/)  
+Django [Coding style](https://docs.djangoproject.com/en/stable/internals/contributing/writing-code/coding-style/)  
 
-For this:  
-All files will be formated using the [black](https://black.readthedocs.io/en/stable/) auto-formatter.  
-Configuration is stored in pyproject.toml  
+## linting
 
-[isort](https://github.com/PyCQA/isort#readme) is used to automate import sorting.  
+The [ruff](https://docs.astral.sh/ruff/) linter is used to enforce code style. A [pre-commit hook](./getting-started.md#3-enable-pre-commit-hooks) which runs this automatically is included with NetBox. To invoke `ruff` manually, run:
+
+```
+python3 -m pip install ruff
+ruff check netbox_contract/
+```
 
-Linting and PEP8 style enforcement will be done with  [Flake8](https://flake8.pycqa.org/en/latest/) which is a wrapper arround:  
-- PyFlakes
-- pycodestyle
-- Ned Batchelder’s McCabe script
-Configuration is maintained in the .flake8 file (no support for pyproject.toml)
 
 The pre-commit Python framework is used to simplify the managment of pre-commit hooks.  
 Config is stored in .pre-commit-config.yaml   
@@ -100,7 +98,13 @@ Make sure taht at the Netbox installtion step you follow the "Option B: Clone th
 
     Connect to the name or IP of the server (as defined in ALLOWED_HOSTS) on port 8000; for example, http://127.0.0.1:8000/.
 
-9. Commit your changes and push your branch to GitHub:
+9. Run unittest
+
+    ```
+    $ python3 netbox/netbox/manage.py test netbox_contract
+    ```
+
+10. Commit your changes and push your branch to GitHub:
 
     ```
     $ git add .
@@ -108,7 +112,7 @@ Make sure taht at the Netbox installtion step you follow the "Option B: Clone th
     $ git push origin name-of-your-bugfix-or-feature
     ```
 
-10. Submit a pull request through the GitHub website.
+1. Submit a pull request through the GitHub website.
 
 ## Model changes
 

{netbox_contract-2.3.1 → netbox_contract-2.3.2}/MANIFEST.in

@@ -9,5 +9,5 @@ recursive-exclude * *.py[co]
 recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif
 
 
-graft src/netbox_contract/templates
-graft src/netbox_contract/templates/netbox_contract
+graft netbox_contract/templates
+graft netbox_contract/templates/netbox_contract

{netbox_contract-2.3.1/src/netbox_contract.egg-info → netbox_contract-2.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: netbox-contract
-Version: 2.3.1
+Version: 2.3.2
 Summary: Contract management plugin for Netbox
 Author-email: Marc Lebreuil <marc@famillelebreuil.net>
 Project-URL: Homepage, https://github.com/mlebreuil/netbox-contract
@@ -14,7 +14,7 @@ License-File: LICENSE
 Requires-Dist: python-dateutil
 Requires-Dist: drf_yasg
 
-# Contract pluggin
+# Contract plugin
 
 NetBox plugin to manage contracts.
 
@@ -24,11 +24,11 @@ NetBox plugin to manage contracts.
 
 ## Features
 
-The pluggin adds contracts and invoices model to Netbox.  
+The plugin adds contracts and invoices model to NetBox.  
 It allows to link contract with objects.  
 And link invoice templates and invoices with contracts.  
 Invoice lines can be linked to each invoice / invoice template.  
-Accounitng dimentoins can be linked with invoice lines.  
+Accounting dimensions can be linked with invoice lines.  
 
 ## Compatibility
 
@@ -54,7 +54,7 @@ $ python3 -m pip install netbox-contract
 
 ### Configure NetBox
 
-Finally, we need to configure NetBox to enable our new plugin. Over in the NetBox installation path, open `netbox/netbox/configuration.py` and look for the `PLUGINS` parameter; this should be an empty list. (If it's not yet defined, go ahead and create it.) Add the name of our plugin to this list:
+Finally, we need to configure NetBox to enable our new plugin. In the NetBox installation directory, open `netbox/netbox/configuration.py` and locate the `PLUGINS` parameter; it should be an empty list. (If it's not yet defined, go ahead and create it.) Add the name of our plugin to this list:
 
 ```python
 # configuration.py
@@ -65,7 +65,7 @@ PLUGINS = [
 
 ### Customize the plugin
 
-The following configurationitems can be set:
+The following configuration items can be set:
 
 ```python
 # configuration.py
@@ -100,7 +100,7 @@ FIELD_CHOICES = {
         ('entity2', 'Entity 2', 'yellow'),
     ),
     'netbox_contract.Contract.currency': (
-        ('usd', 'USD'),
+        ('usd', 'USD'),  # 1st position is the default currency
         ('eur', 'EUR'),
         ('chf', 'CHF'),
         ('pln', 'PLN'),

{netbox_contract-2.3.1 → netbox_contract-2.3.2}/README.md

@@ -1,4 +1,4 @@
-# Contract pluggin
+# Contract plugin
 
 NetBox plugin to manage contracts.
 
@@ -8,11 +8,11 @@ NetBox plugin to manage contracts.
 
 ## Features
 
-The pluggin adds contracts and invoices model to Netbox.  
+The plugin adds contracts and invoices model to NetBox.  
 It allows to link contract with objects.  
 And link invoice templates and invoices with contracts.  
 Invoice lines can be linked to each invoice / invoice template.  
-Accounitng dimentoins can be linked with invoice lines.  
+Accounting dimensions can be linked with invoice lines.  
 
 ## Compatibility
 
@@ -38,7 +38,7 @@ $ python3 -m pip install netbox-contract
 
 ### Configure NetBox
 
-Finally, we need to configure NetBox to enable our new plugin. Over in the NetBox installation path, open `netbox/netbox/configuration.py` and look for the `PLUGINS` parameter; this should be an empty list. (If it's not yet defined, go ahead and create it.) Add the name of our plugin to this list:
+Finally, we need to configure NetBox to enable our new plugin. In the NetBox installation directory, open `netbox/netbox/configuration.py` and locate the `PLUGINS` parameter; it should be an empty list. (If it's not yet defined, go ahead and create it.) Add the name of our plugin to this list:
 
 ```python
 # configuration.py
@@ -49,7 +49,7 @@ PLUGINS = [
 
 ### Customize the plugin
 
-The following configurationitems can be set:
+The following configuration items can be set:
 
 ```python
 # configuration.py
@@ -84,7 +84,7 @@ FIELD_CHOICES = {
         ('entity2', 'Entity 2', 'yellow'),
     ),
     'netbox_contract.Contract.currency': (
-        ('usd', 'USD'),
+        ('usd', 'USD'),  # 1st position is the default currency
         ('eur', 'EUR'),
         ('chf', 'CHF'),
         ('pln', 'PLN'),

{netbox_contract-2.3.1/src → netbox_contract-2.3.2}/netbox_contract/__init__.py

@@ -5,7 +5,7 @@ class ContractsConfig(PluginConfig):
     name = 'netbox_contract'
     verbose_name = 'Netbox contract'
     description = 'Contract management plugin for Netbox'
-    version = '2.3.1'
+    version = '2.3.2'
     author = 'Marc Lebreuil'
     author_email = 'marc@famillelebreuil.net'
     base_url = 'contracts'

netbox_contract-2.3.2/netbox_contract/constants.py

@@ -0,0 +1,13 @@
+from django.db.models import Q
+
+SERVICE_PROVIDER_MODELS = Q(
+    Q(app_label='circuits', model__in=('provider',))
+    | Q(app_label='netbox_contract', model__in=('serviceprovider',))
+)
+
+ASSIGNEMENT_MODELS = Q(
+    Q(app_label='circuits', model__in=('circuit',))
+    | Q(app_label='dcim', model__in=('site',))
+    | Q(app_label='dcim', model__in=('device',))
+    | Q(app_label='virtualization', model__in=('virtualmachine',))
+)

{netbox_contract-2.3.1/src → netbox_contract-2.3.2}/netbox_contract/forms.py

@@ -10,6 +10,7 @@ from netbox.forms import (
     NetBoxModelImportForm,
 )
 from tenancy.models import Tenant
+from tenancy.forms import TenancyFilterForm
 from utilities.forms import BOOLEAN_WITH_BLANK_CHOICES
 from utilities.forms.fields import (
     CommentField,
@@ -25,7 +26,7 @@ from utilities.forms.fields import (
 )
 from utilities.forms.widgets import DatePicker, HTMXSelect
 
-from .constants import SERVICE_PROVIDER_MODELS
+from .constants import SERVICE_PROVIDER_MODELS, ASSIGNEMENT_MODELS
 from .models import (
     AccountingDimension,
     AccountingDimensionStatusChoices,
@@ -134,10 +135,9 @@ class ContractForm(NetBoxModelForm):
             raise ValidationError('you should set monthly OR yearly recuring costs not both')
 
 
-class ContractFilterForm(NetBoxModelFilterSetForm):
+class ContractFilterForm(TenancyFilterForm, NetBoxModelFilterSetForm):
     model = Contract
 
-    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'))
@@ -353,7 +353,7 @@ class InvoiceFilterForm(NetBoxModelFilterSetForm):
 
 
 class InvoiceCSVForm(NetBoxModelImportForm):
-    contracts = CSVModelChoiceField(
+    contracts = CSVModelMultipleChoiceField(
         queryset=Contract.objects.all(),
         to_field_name='name',
         help_text='Related Contracts',
@@ -378,7 +378,7 @@ class InvoiceCSVForm(NetBoxModelImportForm):
 
 
 class InvoiceBulkEditForm(NetBoxModelBulkEditForm):
-    number = forms.CharField(max_length=100, required=True, label=_('Number'))
+    number = forms.CharField(max_length=100, required=False, label=_('Number'))
     template = forms.BooleanField(
         required=False,
         label=_('Template'),
@@ -453,7 +453,7 @@ class ServiceProviderCSVForm(NetBoxModelImportForm):
 
 
 class ServiceProviderBulkEditForm(NetBoxModelBulkEditForm):
-    name = forms.CharField(max_length=100, required=True, label=_('Name'))
+    name = forms.CharField(max_length=100, required=False, label=_('Name'))
     comments = CommentField(label=_('Comments'))
     nullable_fields = ('comments',)
     model = ServiceProvider
@@ -463,21 +463,32 @@ class ServiceProviderBulkEditForm(NetBoxModelBulkEditForm):
 
 
 class ContractAssignmentForm(NetBoxModelForm):
-    contract = DynamicModelChoiceField(queryset=Contract.objects.all(), selector=True, label=_('Contract'))
+
+    content_type = ContentTypeChoiceField(
+        queryset=ContentType.objects.all(),
+        limit_choices_to=ASSIGNEMENT_MODELS,
+        label=_('object type'),
+    )
+
+    contract = DynamicModelChoiceField(
+        queryset=Contract.objects.all(),
+        selector=True,
+        label=_('Contract'))
 
     class Meta:
         model = ContractAssignment
         fields = ['content_type', 'object_id', 'contract', 'tags']
-        widgets = {
-            'content_type': forms.HiddenInput(),
-            'object_id': forms.HiddenInput(),
-        }
+        # widgets = {
+        #     'content_type': forms.HiddenInput(),
+        #     'object_id': forms.HiddenInput(),
+        # }
 
 
 class ContractAssignmentFilterForm(NetBoxModelFilterSetForm):
     model = ContractAssignment
     contract = DynamicModelChoiceField(
         queryset=Contract.objects.all(),
+        required=False,
         selector=True,
         label=_('Contract'),
     )
@@ -486,6 +497,7 @@ class ContractAssignmentFilterForm(NetBoxModelFilterSetForm):
 class ContractAssignmentImportForm(NetBoxModelImportForm):
     content_type = CSVContentTypeField(
         queryset=ContentType.objects.all(),
+        limit_choices_to=ASSIGNEMENT_MODELS,
         help_text='Content Type in the form <app>.<model>',
         label=_('Content type'),
     )
@@ -500,6 +512,16 @@ class ContractAssignmentImportForm(NetBoxModelImportForm):
         fields = ['content_type', 'object_id', 'contract', 'tags']
 
 
+class ContractAssignmentBulkEditForm(NetBoxModelBulkEditForm):
+    contract = DynamicModelChoiceField(
+        queryset=Contract.objects.all(),
+        required=False,
+        selector=True,
+        label=_('Contract'),
+    )
+    model = ContractAssignment
+
+
 # InvoiceLine
 
 
@@ -578,6 +600,7 @@ class InvoiceLineImportForm(NetBoxModelImportForm):
     accounting_dimensions = CSVModelMultipleChoiceField(
         queryset=AccountingDimension.objects.all(),
         to_field_name='id',
+        required=False,
         help_text='accounting dimension id',
         label=_('Accounting dimensions'),
     )
@@ -602,6 +625,8 @@ class InvoiceLineBulkEditForm(NetBoxModelBulkEditForm):
         selector=True,
         label=_('Accounting dimensions'),
     )
+    comments = CommentField(label=_('Comments'))
+    nullable_fields = ('comments',)
     model = InvoiceLine
 
 
@@ -649,4 +674,6 @@ class AccountingDimensionImportForm(NetBoxModelImportForm):
 class AccountingDimensionBulkEditForm(NetBoxModelBulkEditForm):
     name = forms.CharField(max_length=20, required=False, label=_('Name'))
     value = forms.CharField(max_length=20, required=False, label=_('Value'))
+    comments = CommentField(label=_('Comments'))
+    nullable_fields = ('comments',)
     model = AccountingDimension

{netbox_contract-2.3.1/src → netbox_contract-2.3.2}/netbox_contract/migrations/0019_auto_20230924_1813.py

@@ -39,5 +39,5 @@ class Migration(migrations.Migration):
     ]
 
     operations = [
-        migrations.RunPython(migrate_external_partie, reverse_external_partie),
+    #    migrations.RunPython(migrate_external_partie, reverse_external_partie),
     ]

{netbox_contract-2.3.1/src → netbox_contract-2.3.2}/netbox_contract/migrations/0026_auto_20240421_1550.py

@@ -27,5 +27,5 @@ class Migration(migrations.Migration):
     ]
 
     operations = [
-        migrations.RunPython(update_changed_object_type),
+    #    migrations.RunPython(update_changed_object_type),
     ]

netbox_contract-2.3.2/netbox_contract/migrations/0040_alter_contract_currency_alter_invoice_currency_and_more.py

@@ -0,0 +1,28 @@
+# Generated by Django 5.1.5 on 2025-02-23 09:21
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("netbox_contract", "0039_alter_accountingdimension_status_and_more"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="contract",
+            name="currency",
+            field=models.CharField(default="usd", max_length=3),
+        ),
+        migrations.AlterField(
+            model_name="invoice",
+            name="currency",
+            field=models.CharField(default="usd", max_length=3),
+        ),
+        migrations.AlterField(
+            model_name="invoiceline",
+            name="currency",
+            field=models.CharField(default="usd", max_length=3),
+        ),
+    ]

{netbox_contract-2.3.1/src → netbox_contract-2.3.2}/netbox_contract/models.py

@@ -9,6 +9,8 @@ from django.utils.translation import gettext_lazy as _
 from netbox.models import NetBoxModel
 from netbox.models.features import ContactsMixin
 from utilities.choices import ChoiceSet
+from dcim.choices import DeviceStatusChoices, SiteStatusChoices
+from virtualization.choices import VirtualMachineStatusChoices
 
 
 class StatusChoices(ChoiceSet):
@@ -135,6 +137,18 @@ class ContractAssignment(NetBoxModel):
     def get_absolute_url(self):
         return reverse('plugins:netbox_contract:contractassignment', args=[self.pk])
 
+    def get_contract__status_color(self):
+        return StatusChoices.colors.get(self.contract.status)
+
+    def get_content_object__status_color(self):
+        STATUS_MAPPING = {
+            'virtualmachine': VirtualMachineStatusChoices.colors,
+            'device': DeviceStatusChoices.colors,
+            'site': SiteStatusChoices.colors,
+        }
+        status_colors = STATUS_MAPPING.get(self.content_type.model, StatusChoices.colors)
+        return status_colors.get(self.content_object.status)
+
 
 class Contract(NetBoxModel):
     name = models.CharField(max_length=100, verbose_name=_('name'))

{netbox_contract-2.3.1/src → netbox_contract-2.3.2}/netbox_contract/tables.py

@@ -12,16 +12,18 @@ from .models import (
 
 
 class ContractAssignmentListTable(NetBoxTable):
+    id = tables.Column(linkify=True)
     content_type = columns.ContentTypeColumn(verbose_name='Object Type')
     content_object = tables.Column(linkify=True, orderable=False)
     contract = tables.Column(linkify=True)
     actions = columns.ActionsColumn(actions=('edit', 'delete'))
     contract__external_partie_object = tables.Column(linkify=True)
+    tags = columns.TagColumn(url_name='plugins:netbox_contract:contractassignment_list')
 
     class Meta(NetBoxTable.Meta):
         model = ContractAssignment
         fields = (
-            'pk',
+            'id',
             'content_type',
             'content_object',
             'contract',
@@ -30,7 +32,7 @@ class ContractAssignmentListTable(NetBoxTable):
             'actions',
         )
         default_columns = (
-            'pk',
+            'id',
             'content_type',
             'content_object',
             'contract',
@@ -108,6 +110,7 @@ class ContractListTable(NetBoxTable):
     status = columns.ChoiceFieldColumn(
         verbose_name=('Status'),
     )
+    tags = columns.TagColumn(url_name='plugins:netbox_contract:contract_list')
 
     class Meta(NetBoxTable.Meta):
         model = Contract
@@ -171,6 +174,7 @@ class ContractListBottomTable(NetBoxTable):
 class InvoiceListTable(NetBoxTable):
     contracts = tables.ManyToManyColumn(linkify=True)
     number = tables.Column(linkify=True)
+    tags = columns.TagColumn(url_name='plugins:netbox_contract:invoiceline_list')
 
     class Meta(NetBoxTable.Meta):
         model = Invoice
@@ -200,6 +204,7 @@ class InvoiceListTable(NetBoxTable):
 
 class ServiceProviderListTable(NetBoxTable):
     name = tables.Column(linkify=True)
+    tags = columns.TagColumn(url_name='plugins:netbox_contract:serviceprovider_list')
 
     class Meta(NetBoxTable.Meta):
         model = ServiceProvider
@@ -209,7 +214,8 @@ class ServiceProviderListTable(NetBoxTable):
 
 class InvoiceLineListTable(NetBoxTable):
     invoice = tables.Column(linkify=True)
-    accounting_dimensions = tables.ManyToManyColumn(linkify=True, filter=lambda qs: qs.order_by('name'))
+    accounting_dimensions = tables.ManyToManyColumn(linkify_item=True, filter=lambda qs: qs.order_by('name'))
+    tags = columns.TagColumn(url_name='plugins:netbox_contract:invoiceline_list')
 
     class Meta(NetBoxTable.Meta):
         model = InvoiceLine
@@ -232,9 +238,11 @@ class InvoiceLineListTable(NetBoxTable):
 
 
 class AccountingDimensionListTable(NetBoxTable):
+    name = tables.Column(linkify=True)
     status = columns.ChoiceFieldColumn(
         verbose_name=('Status'),
     )
+    tags = columns.TagColumn(url_name='plugins:netbox_contract:accountingdimension_list')
 
     class Meta(NetBoxTable.Meta):
         model = AccountingDimension

netbox_contract-2.3.2/netbox_contract/tests/custom.py

@@ -0,0 +1,18 @@
+from django.urls import reverse
+from utilities.testing.api import APITestCase as NetBoxAPITestCase
+from utilities.testing.views import ModelViewTestCase as NetBoxModelViewTestCase
+
+
+class ModelViewTestCase(NetBoxModelViewTestCase):
+    def _get_base_url(self):
+        return f'plugins:{self.model._meta.app_label}:{self.model._meta.model_name}_{{}}'
+
+
+class APITestCase(NetBoxAPITestCase):
+    def _get_detail_url(self, instance):
+        viewname = f'plugins-api:{self._get_view_namespace()}:{instance._meta.model_name}-detail'
+        return reverse(viewname, kwargs={'pk': instance.pk})
+
+    def _get_list_url(self):
+        viewname = f'plugins-api:{self._get_view_namespace()}:{self.model._meta.model_name}-list'
+        return reverse(viewname)