Merge pull request #29 from mariokakoulli/netbox-upgrade-4.2

Netbox upgrade 4.2

Author: jasonyates

CONTRIBUTING.md

@@ -94,7 +94,7 @@ Before you submit a pull request, check that it meets these guidelines:
 2. If the pull request adds functionality, the docs should be updated. Put
    your new functionality into a function with a docstring, and add the
    feature to the list in README.md.
-3. The pull request should work for Python 3.6, 3.7, 3.8 and 3.9. Check
+3. The pull request should work for Python 3.10, 3.11, and 3.12. Check
    https://github.com/jasonyates/netbox_circuitmaintenance/actions
    and make sure that the tests pass for all supported Python versions.
 

README.md

@@ -18,6 +18,7 @@ The plugin does not directly provide an automated approach to ingesting provider
 This plugin is only supported on NetBox 3.4 or higher, for exact compatibility information, see the table below.  
 | NetBox Version | Plugin Version |
 |--|--|
+| 4.2+ | 0.5.0 |
 | 4.0+ | 0.4.2 |
 | 3.5 | 0.3.0 |
 | 3.4 | 0.2.2 |
@@ -45,7 +46,7 @@ To ensure the Netbox Documents plugin is automatically re-installed during futur
 
 ### Enable the Plugin
 
-In the Netbox `configuration.py` configuration file add or update the PLUGINS parameter, adding `netbox_documents`:
+In the Netbox `configuration.py` configuration file add or update the PLUGINS parameter, adding `netbox_circuitmaintenance`:
 
 
 ```python

netbox_circuitmaintenance/__init__.py

@@ -2,7 +2,7 @@
 
 __author__ = """Jason Yates"""
 __email__ = 'me@jasonyates.co.uk'
-__version__ = '0.4.2'
+__version__ = '0.5.0'
 
 
 from netbox.plugins import PluginConfig

netbox_circuitmaintenance/api/serializers.py

@@ -2,7 +2,7 @@
 
 from netbox.api.serializers import NetBoxModelSerializer, WritableNestedSerializer
 from ..models import CircuitMaintenance, CircuitMaintenanceImpact, CircuitMaintenanceNotifications
-from circuits.api.nested_serializers import NestedProviderSerializer, NestedCircuitSerializer
+from circuits.api.serializers import ProviderSerializer, CircuitSerializer
 
 
 
@@ -11,7 +11,7 @@ class NestedCircuitMaintenanceImpactSerializer(WritableNestedSerializer):
         view_name='plugins-api:netbox_circuitmaintenance-api:circuitmaintenanceimpact-detail'
     )
 
-    circuit = NestedCircuitSerializer()
+    circuit = CircuitSerializer(nested=True)
 
     class Meta:
         model = CircuitMaintenanceImpact
@@ -24,7 +24,7 @@ class NestedCircuitMaintenanceSerializer(WritableNestedSerializer):
         view_name='plugins-api:netbox_circuitmaintenance-api:circuitmaintenance-detail'
     )
 
-    provider = NestedProviderSerializer()
+    provider = ProviderSerializer(nested=True)
 
     class Meta:
         model = CircuitMaintenance
@@ -50,7 +50,7 @@ class CircuitMaintenanceSerializer(NetBoxModelSerializer):
         view_name='plugins-api:netbox_circuitmaintenance-api:circuitmaintenance-detail'
     )
 
-    provider = NestedProviderSerializer()
+    provider = ProviderSerializer(nested=True)
     impact = NestedCircuitMaintenanceImpactSerializer(required=False, many=True)
     notification = NestedCircuitMaintenanceNotificationsSerializer(required=False, many=True)
 
@@ -67,7 +67,7 @@ class CircuitMaintenanceImpactSerializer(NetBoxModelSerializer):
         view_name='plugins-api:netbox_circuitmaintenance-api:circuitmaintenanceimpact-detail'
     )
 
-    circuit = NestedCircuitSerializer()
+    circuit = CircuitSerializer(nested=True)
     circuitmaintenance = NestedCircuitMaintenanceSerializer()
 
     class Meta:

pyproject.toml

@@ -1,44 +1,99 @@
 # pyproject.toml
 
 [build-system]
-requires = ["setuptools>=61.0.0", "wheel"]
+requires = ["setuptools"]
 build-backend = "setuptools.build_meta"
 
+[tool.setuptools.packages.find]
+include = ["netbox_circuitmaintenance", "netbox_circuitmaintenance.*"]
+
 [project]
 name = "netbox-circuitmaintenance"
-version = "0.3.0"
+keywords = ['netbox_circuitmaintenance']
+version = "0.5.0"
 description = "Provides the ability to record circuit maintenance, maintenance impact and maintenance notifications in Netbox and link them to Providers and Circuits."
 readme = "README.md"
 authors = [{ name = "Jason Yates", email = "me@jasonyates.co.uk" }]
-license = { file = "LICENSE" }
+license-files = ["LICENSE"]
+
+classifiers = [
+    'Development Status :: 2 - Pre-Alpha',
+    'Intended Audience :: Developers',
+    'Natural Language :: English',
+    'Programming Language :: Python :: 3',
+    'Programming Language :: Python :: 3.10',
+    'Programming Language :: Python :: 3.11',
+    'Programming Language :: Python :: 3.12',
+]
+
+requires-python = ">=3.10.0"
+
+[project.optional-dependencies]
+dev = [
+    "black==25.1.0",
+    "bumpver",
+    "isort==6.0.1",
+    "pip-tools",
+    "pytest",
+    "flake8==7.2.0",
+    "pyproject-flake8==7.0.0",
+    "twine==6.1.0",
+    "Sphinx==8.2.3",
+    "watchdog==6.0.0",
+]
 
 [project.urls]
 Homepage = "https://github.com/jasonyates/netbox-circuitmaintenance"
+Documentation = "https://jasonyates.github.io/netbox-circuitmaintenance"
+Source = "https://github.com/jasonyates/netbox-circuitmaintenance"
+Tracker = "https://github.com/jasonyates/netbox-circuitmaintenance/issues"
 
-[project.optional-dependencies]
-dev = ["black", "bumpver", "isort", "pip-tools", "pytest"]
 
 [tool.bumpver]
-current_version = "0.3.0"
+current_version = "0.5.0"
 version_pattern = "MAJOR.MINOR.PATCH"
 commit_message = "bump version {old_version} -> {new_version}"
 commit = true
 tag = true
 push = true
 
 [tool.bumpver.file_patterns]
-"pyproject.toml" = [
-    'current_version = "{version}"',
-]
-"setup.py" = [
-    "{version}",
-    "{pep440_version}",
-]
-"README.md" = [
-    "{version}",
-    "{pep440_version}",
-]
-"netbox_circuitmaintenance/__init__.py" = [
-    "{version}",
-    "{__version__}",
+"pyproject.toml" = ['current_version = "{version}"']
+"README.md" = ["{version}", "{pep440_version}"]
+"netbox_circuitmaintenance/__init__.py" = ["{version}", "{__version__}"]
+
+[tool.flake8]
+max-line-length = 120
+max-complexity = 18
+extend-ignore = ["E203", "E266", "W503"]
+per-file-ignores = ["__init__.py:F401"]
+exclude = [
+    ".git",
+    "__pycache__",
+    "setup.py",
+    "build",
+    "dist",
+    "docs",
+    "releases",
+    ".venv",
+    ".tox",
+    ".mypy_cache",
+    ".pytest_cache",
+    ".vscode",
+    ".github",
 ]
+# By default test codes will be linted.
+# tests
+
+[tool.tox]
+legacy_tox_ini = """
+[tox:tox]
+isolated_build = true
+envlist = py310, py311, py312, format, lint, build
+
+[gh-actions]
+python =
+    3.12: py312
+    3.11: py311
+    3.10: py310, format, lint, build
+"""