netbox-cadplan 0.2.0__tar.gz

netbox_cadplan-0.2.0/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## 0.2.0
+
+- Add "Position by distance" tool and object selection highlighting on the
+  plan canvas.
+- Add Center view control, fit-to-view canvas sizing, and pickable-list
+  refresh.
+- Theme-aware label colors on canvas.
+- Cache parsed DXF documents and only list layers with geometry, for faster
+  layer selection.
+- Replace the layer selection list with a searchable dropdown with a loading
+  state.
+- Link to device type shape configuration directly from unplaceable devices.
+- Switch the default UI to English, with French available as a translation.
+- Fix Properties panel not refreshing after right-click rotate on a selected
+  object.
+
+## 0.1.0
+
+- Initial release: import DXF/DWG plans linked to Sites and Locations.
+- Automatic zone splitting matched to descendant Locations, with per-location
+  SVG display tab.
+- Device type plan shapes and interactive object placement on zones.
+- DXF re-export.

netbox_cadplan-0.2.0/CONTRIBUTING.md

@@ -0,0 +1,14 @@
+# Contributing
+
+Thank you for your interest in contributing to netbox-cadplan.
+
+- Please open issues for bugs or feature requests on the repository issue tracker.
+- For code contributions, fork the repository, create a feature branch, and open a pull request.
+- Ensure linters and tests pass before submitting a PR.
+
+Guidelines:
+- Keep changes focused and well-documented.
+- Add tests for new features or bug fixes.
+- Run `ruff` and `black` to format and lint code.
+
+Maintainer contact: see repository settings.

netbox_cadplan-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Simon Lacroix
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

netbox_cadplan-0.2.0/MANIFEST.in

@@ -0,0 +1,7 @@
+include LICENSE
+include README.md
+include CHANGELOG.md
+include CONTRIBUTING.md
+recursive-include netbox_cadplan/templates *
+recursive-include netbox_cadplan/static *
+recursive-include netbox_cadplan/locale *

netbox_cadplan-0.2.0/PKG-INFO

@@ -0,0 +1,124 @@
+Metadata-Version: 2.4
+Name: netbox-cadplan
+Version: 0.2.0
+Summary: NetBox plugin: visual floor-plan management linked to Sites and Locations, with DXF/DWG import
+Author: G1tHub-PRO, SelfSimon
+License: MIT
+Project-URL: Homepage, https://github.com/SelfSimon/netbox-cadplan
+Project-URL: Repository, https://github.com/SelfSimon/netbox-cadplan
+Project-URL: Bug Tracker, https://github.com/SelfSimon/netbox-cadplan/issues
+Keywords: netbox,plugin,plan,floorplan,dxf,dwg,sites,locations
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Plugins
+Classifier: Framework :: Django
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: System :: Networking
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: ezdxf
+Requires-Dist: svgwrite
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: ruff>=0.12.0; extra == "dev"
+Requires-Dist: black>=23.0; extra == "dev"
+Requires-Dist: pre-commit>=2.20; extra == "dev"
+Dynamic: license-file
+
+# netbox-cadplan
+
+NetBox plugin for visual floor-plan management. A plan is attached to a
+NetBox `Site` (required) and, optionally, to a `Location` within that site,
+based on an imported DXF/DWG file. The plan is split into zones associated
+with locations (descendant Locations of the plan's Location, or the whole
+site if no Location is specified), with the SVG of each location displayed
+in a dedicated tab on its NetBox page.
+
+## Compatibility
+
+| Package | NetBox        | Python |
+|---------|---------------|--------|
+| 0.1.x   | 4.6.0 – 4.6.99 | ≥ 3.10 |
+
+## Installation
+
+### 1. Install the package
+
+```bash
+pip install netbox-cadplan
+# or from source:
+pip install git+https://github.com/simonlacroix/netbox-cadplan.git
+```
+
+### 2. Enable the plugin in NetBox
+
+Add the plugin to `configuration.py` (or `configuration/plugins.py` depending
+on your setup):
+
+```python
+PLUGINS = [
+    # ... other plugins
+    'netbox_cadplan',
+]
+```
+
+### 3. Run migrations and restart NetBox
+
+```bash
+python manage.py migrate netbox_cadplan
+sudo systemctl restart netbox netbox-rq
+```
+
+## Usage
+
+- Import a DXF/DWG file to create a **Plan**, linked to a Site and optionally
+  a Location.
+- The plan is automatically split into **zones** matched to Locations
+  descending from the plan's scope.
+- Each Location gets a dedicated tab showing the SVG of its zone.
+- Objects (device types with a configured plan shape) can be placed on a
+  zone and repositioned interactively.
+- Plans can be re-exported to DXF.
+
+## License
+
+MIT — see [LICENSE](LICENSE).
+
+## Contributors
+
+- [Simon Lacroix](https://github.com/simonlacroix) — Original author
+
+## Developer setup
+
+Quick setup for contributors — creates a virtualenv, installs development
+dependencies and installs the `pre-commit` git hooks.
+
+PowerShell (Windows):
+
+```powershell
+python -m venv .venv
+.\.venv\Scripts\Activate.ps1
+python -m pip install --upgrade pip
+pip install -e ".[dev]"
+pre-commit install
+pre-commit run --all-files
+```
+
+POSIX (macOS / Linux):
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+python -m pip install --upgrade pip
+pip install -e '.[dev]'
+pre-commit install
+pre-commit run --all-files
+```
+
+If you prefer automation, run `scripts/bootstrap.ps1` on Windows or
+`scripts/bootstrap.sh` on POSIX systems to perform these steps.

netbox_cadplan-0.2.0/README.md

@@ -0,0 +1,92 @@
+# netbox-cadplan
+
+NetBox plugin for visual floor-plan management. A plan is attached to a
+NetBox `Site` (required) and, optionally, to a `Location` within that site,
+based on an imported DXF/DWG file. The plan is split into zones associated
+with locations (descendant Locations of the plan's Location, or the whole
+site if no Location is specified), with the SVG of each location displayed
+in a dedicated tab on its NetBox page.
+
+## Compatibility
+
+| Package | NetBox        | Python |
+|---------|---------------|--------|
+| 0.1.x   | 4.6.0 – 4.6.99 | ≥ 3.10 |
+
+## Installation
+
+### 1. Install the package
+
+```bash
+pip install netbox-cadplan
+# or from source:
+pip install git+https://github.com/simonlacroix/netbox-cadplan.git
+```
+
+### 2. Enable the plugin in NetBox
+
+Add the plugin to `configuration.py` (or `configuration/plugins.py` depending
+on your setup):
+
+```python
+PLUGINS = [
+    # ... other plugins
+    'netbox_cadplan',
+]
+```
+
+### 3. Run migrations and restart NetBox
+
+```bash
+python manage.py migrate netbox_cadplan
+sudo systemctl restart netbox netbox-rq
+```
+
+## Usage
+
+- Import a DXF/DWG file to create a **Plan**, linked to a Site and optionally
+  a Location.
+- The plan is automatically split into **zones** matched to Locations
+  descending from the plan's scope.
+- Each Location gets a dedicated tab showing the SVG of its zone.
+- Objects (device types with a configured plan shape) can be placed on a
+  zone and repositioned interactively.
+- Plans can be re-exported to DXF.
+
+## License
+
+MIT — see [LICENSE](LICENSE).
+
+## Contributors
+
+- [Simon Lacroix](https://github.com/simonlacroix) — Original author
+
+## Developer setup
+
+Quick setup for contributors — creates a virtualenv, installs development
+dependencies and installs the `pre-commit` git hooks.
+
+PowerShell (Windows):
+
+```powershell
+python -m venv .venv
+.\.venv\Scripts\Activate.ps1
+python -m pip install --upgrade pip
+pip install -e ".[dev]"
+pre-commit install
+pre-commit run --all-files
+```
+
+POSIX (macOS / Linux):
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+python -m pip install --upgrade pip
+pip install -e '.[dev]'
+pre-commit install
+pre-commit run --all-files
+```
+
+If you prefer automation, run `scripts/bootstrap.ps1` on Windows or
+`scripts/bootstrap.sh` on POSIX systems to perform these steps.

netbox_cadplan-0.2.0/netbox_cadplan/__init__.py

@@ -0,0 +1,28 @@
+try:
+    from netbox.plugins import PluginConfig
+except Exception:
+    # Minimal fallback for local development / tests when NetBox is not
+    # available. This avoids import-time errors during pytest collection.
+    class PluginConfig:  # type: ignore
+        pass
+
+
+class NetBoxCadPlanConfig(PluginConfig):
+    name = "netbox_cadplan"
+    verbose_name = "NetBox CadPlan"
+    description = "Visual floor-plan management linked to Sites and Locations"
+    version = "0.2.0"
+    author = "Simon Lacroix"
+    author_email = "simonlacroix@live.ca"
+    base_url = "cadplan"
+    min_version = "4.6.0"
+    max_version = "4.6.99"
+    required_settings = []
+    default_settings = {}
+
+    def ready(self):
+        super().ready()
+        from . import signals  # noqa: F401
+
+
+config = NetBoxCadPlanConfig

netbox_cadplan-0.2.0/netbox_cadplan/api/serializers.py

@@ -0,0 +1,125 @@
+from core.models import ObjectType
+from dcim.api.serializers import (
+    DeviceTypeSerializer,
+    LocationSerializer,
+    SiteSerializer,
+)
+from netbox.api.fields import ContentTypeField
+from netbox.api.gfk_fields import GFKSerializerField
+from netbox.api.serializers import NetBoxModelSerializer
+from rest_framework import serializers
+
+from ..models import DeviceTypeShape, PlacedObject, Plan, PlanZone
+
+
+class PlanSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_cadplan-api:plan-detail"
+    )
+    site = SiteSerializer(nested=True)
+    location = LocationSerializer(nested=True, required=False, allow_null=True)
+
+    class Meta:
+        model = Plan
+        fields = [
+            "id",
+            "url",
+            "display",
+            "name",
+            "site",
+            "location",
+            "dxf_file",
+            "selected_layer",
+            "width_px",
+            "height_px",
+            "mm_per_px",
+            "tags",
+            "custom_fields",
+            "created",
+            "last_updated",
+        ]
+        brief_fields = ("id", "url", "display", "name")
+
+
+class PlanZoneSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_cadplan-api:planzone-detail"
+    )
+    plan = PlanSerializer(nested=True)
+    location = LocationSerializer(nested=True, required=False, allow_null=True)
+
+    class Meta:
+        model = PlanZone
+        fields = [
+            "id",
+            "url",
+            "display",
+            "plan",
+            "number",
+            "location",
+            "polygon_data",
+            "svg_file",
+            "label",
+            "tags",
+            "custom_fields",
+            "created",
+            "last_updated",
+        ]
+        brief_fields = ("id", "url", "display", "number", "label")
+
+
+class DeviceTypeShapeSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_cadplan-api:devicetypeshape-detail"
+    )
+    device_type = DeviceTypeSerializer(nested=True)
+
+    class Meta:
+        model = DeviceTypeShape
+        fields = [
+            "id",
+            "url",
+            "display",
+            "device_type",
+            "shape",
+            "width",
+            "depth",
+            "diameter",
+            "unit",
+            "tags",
+            "custom_fields",
+            "created",
+            "last_updated",
+        ]
+        brief_fields = ("id", "url", "display", "device_type", "shape")
+
+
+class PlacedObjectSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_cadplan-api:placedobject-detail"
+    )
+    zone = PlanZoneSerializer(nested=True)
+    object_type = ContentTypeField(queryset=ObjectType.objects.all())
+    object = GFKSerializerField(source="content_object", read_only=True)
+
+    class Meta:
+        model = PlacedObject
+        fields = [
+            "id",
+            "url",
+            "display",
+            "zone",
+            "object_type",
+            "object_id",
+            "object",
+            "x",
+            "y",
+            "rotation",
+            "snap_to_wall",
+            "name_position",
+            "tags",
+            "custom_fields",
+            "created",
+            "last_updated",
+        ]
+        brief_fields = ("id", "url", "display", "object_type", "object_id")

netbox_cadplan-0.2.0/netbox_cadplan/api/urls.py

@@ -0,0 +1,12 @@
+from netbox.api.routers import NetBoxRouter
+
+from . import views
+
+app_name = "netbox_cadplan"
+router = NetBoxRouter()
+router.register("plans", views.PlanViewSet)
+router.register("plan-zones", views.PlanZoneViewSet)
+router.register("device-type-shapes", views.DeviceTypeShapeViewSet)
+router.register("placed-objects", views.PlacedObjectViewSet)
+
+urlpatterns = router.urls

netbox_cadplan-0.2.0/netbox_cadplan/api/views.py

@@ -0,0 +1,30 @@
+from netbox.api.viewsets import NetBoxModelViewSet
+
+from .. import filtersets, models
+from .serializers import (
+    DeviceTypeShapeSerializer,
+    PlacedObjectSerializer,
+    PlanSerializer,
+    PlanZoneSerializer,
+)
+
+
+class PlanViewSet(NetBoxModelViewSet):
+    queryset = models.Plan.objects.all()
+    serializer_class = PlanSerializer
+    filterset_class = filtersets.PlanFilterSet
+
+
+class PlanZoneViewSet(NetBoxModelViewSet):
+    queryset = models.PlanZone.objects.all()
+    serializer_class = PlanZoneSerializer
+
+
+class DeviceTypeShapeViewSet(NetBoxModelViewSet):
+    queryset = models.DeviceTypeShape.objects.all()
+    serializer_class = DeviceTypeShapeSerializer
+
+
+class PlacedObjectViewSet(NetBoxModelViewSet):
+    queryset = models.PlacedObject.objects.all()
+    serializer_class = PlacedObjectSerializer

netbox_cadplan-0.2.0/netbox_cadplan/choices.py

@@ -0,0 +1,41 @@
+from django.utils.translation import gettext_lazy as _
+from utilities.choices import ChoiceSet
+
+
+class ShapeChoices(ChoiceSet):
+
+    RECTANGLE = "rectangle"
+    CIRCLE = "circle"
+
+    CHOICES = (
+        (RECTANGLE, _("Rectangle")),
+        (CIRCLE, _("Circle")),
+    )
+
+
+class LengthUnitChoices(ChoiceSet):
+
+    UNIT_CENTIMETER = "cm"
+    UNIT_INCH = "in"
+
+    CHOICES = (
+        (UNIT_CENTIMETER, _("Centimeters")),
+        (UNIT_INCH, _("Inches")),
+    )
+
+
+class NamePositionChoices(ChoiceSet):
+
+    TOP = "top"
+    BOTTOM = "bottom"
+    LEFT = "left"
+    RIGHT = "right"
+    CENTER = "center"
+
+    CHOICES = (
+        (TOP, _("Top")),
+        (BOTTOM, _("Bottom")),
+        (LEFT, _("Left")),
+        (RIGHT, _("Right")),
+        (CENTER, _("Center")),
+    )

netbox_cadplan-0.2.0/netbox_cadplan/filtersets.py

@@ -0,0 +1,20 @@
+import django_filters
+from django.db.models import Q
+from netbox.filtersets import NetBoxModelFilterSet
+
+from .models import Plan
+
+
+class PlanFilterSet(NetBoxModelFilterSet):
+    q = django_filters.CharFilter(method="search", label="Search")
+
+    class Meta:
+        model = Plan
+        fields = ("id", "name", "site", "location", "selected_layer")
+
+    def search(self, queryset, name, value):
+        if not value.strip():
+            return queryset
+        return queryset.filter(
+            Q(name__icontains=value) | Q(selected_layer__icontains=value)
+        )

netbox_cadplan-0.2.0/netbox_cadplan/forms.py

@@ -0,0 +1,92 @@
+from dcim.models import Location, Site
+from django.core.exceptions import ValidationError
+from django.utils.translation import gettext_lazy as _
+from netbox.forms import NetBoxModelForm
+from utilities.forms.fields import DynamicModelChoiceField
+from utilities.forms.rendering import FieldSet, InlineFields
+
+from .models import DeviceTypeShape, Plan
+
+MAX_DXF_UPLOAD_SIZE = 50 * 1024 * 1024  # 50 Mo
+
+
+def _validate_dxf_size(dxf_file):
+    if dxf_file and dxf_file.size > MAX_DXF_UPLOAD_SIZE:
+        raise ValidationError(
+            _("The DXF/DWG file exceeds the maximum allowed size (50 MB).")
+        )
+    return dxf_file
+
+
+class PlanForm(NetBoxModelForm):
+    site = DynamicModelChoiceField(
+        queryset=Site.objects.all(),
+        required=True,
+    )
+    location = DynamicModelChoiceField(
+        queryset=Location.objects.all(),
+        required=False,
+        query_params={"site_id": "$site"},
+        help_text=_(
+            "Optional NetBox Location (leave empty for a plan covering the whole site)"
+        ),
+    )
+
+    fieldsets = (FieldSet("name", "site", "location", "dxf_file", name=_("Plan")),)
+
+    class Meta:
+        model = Plan
+        fields = ("name", "site", "location", "dxf_file")
+
+    def clean_dxf_file(self):
+        return _validate_dxf_size(self.cleaned_data.get("dxf_file"))
+
+    def clean(self):
+        super().clean()
+        cleaned_data = self.cleaned_data
+        site = cleaned_data.get("site")
+        location = cleaned_data.get("location")
+        if site and location and location.site_id != site.id:
+            self.add_error(
+                "location",
+                _("The selected location does not belong to the chosen site."),
+            )
+        return cleaned_data
+
+
+class ReimportDxfForm(NetBoxModelForm):
+    """
+    Replaces only the DXF file of an already-confirmed plan (not name/site/location,
+    unlike PlanForm) — clears selected_layer on save to make the layer selection
+    panel reappear (see PlanReimportDxfView).
+    """
+
+    fieldsets = (FieldSet("dxf_file", name=_("Reimport a DXF")),)
+
+    class Meta:
+        model = Plan
+        fields = ("dxf_file",)
+
+    def clean_dxf_file(self):
+        return _validate_dxf_size(self.cleaned_data.get("dxf_file"))
+
+    def save(self, commit=True):
+        instance = super().save(commit=False)
+        instance.selected_layer = ""
+        if commit:
+            instance.save()
+        return instance
+
+
+class DeviceTypeShapeForm(NetBoxModelForm):
+    fieldsets = (
+        FieldSet(
+            "shape",
+            InlineFields("width", "depth", "diameter", "unit", label=_("Dimensions")),
+            name=_("Shape"),
+        ),
+    )
+
+    class Meta:
+        model = DeviceTypeShape
+        fields = ("shape", "width", "depth", "diameter", "unit")