nautobot-trax 0.1.0__tar.gz

nautobot_trax-0.1.0/LICENSE

@@ -0,0 +1,15 @@
+Apache Software License 2.0
+
+Copyright (c) 2026, Network to Code, LLC
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

nautobot_trax-0.1.0/PKG-INFO

@@ -0,0 +1,131 @@
+Metadata-Version: 2.4
+Name: nautobot-trax
+Version: 0.1.0
+Summary: Trusted Automation at the Edge - Powered by Nautobot. Tools to enable tactical missions.
+License: Apache-2.0
+License-File: LICENSE
+Keywords: nautobot,nautobot-app,nautobot-plugin
+Author: Dwayne Camacho
+Author-email: dwayne.a.camacho@gmail.com
+Requires-Python: >=3.10,<3.14
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software 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: Programming Language :: Python :: 3.13
+Provides-Extra: all
+Requires-Dist: mgrs (>=1.5.0)
+Requires-Dist: nautobot (>=3.1.8,<4.0.0)
+Requires-Dist: nautobot-design-builder (>=3.0.0,<4.0.0)
+Requires-Dist: nautobot-golden-config (>=3.0.0,<4.0.0)
+Requires-Dist: nautobot-plugin-nornir (>=3.0.0,<4.0.0)
+Project-URL: Documentation, https://github.com/d-camacho/nautobot-app-trax/tree/main/docs
+Project-URL: Homepage, https://github.com/d-camacho/nautobot-app-trax
+Project-URL: Repository, https://github.com/d-camacho/nautobot-app-trax
+Description-Content-Type: text/markdown
+
+# Nautobot TRAX
+
+<p align="center">
+  <img src="https://github.com/d-camacho/nautobot-app-trax/blob/main/docs/images/trax_full.png" class="logo" height="400px" alt="Nautobot TRAX logo">
+  <br>
+  <a href="https://github.com/nautobot/nautobot-app-nautobot-trax/actions"><img src="https://github.com/nautobot/nautobot-app-nautobot-trax/actions/workflows/ci.yml/badge.svg?branch=main" alt="CI"></a>
+  <a href="https://docs.nautobot.com/projects/nautobot-trax/en/latest/"><img src="https://readthedocs.org/projects/nautobot-app-nautobot-trax/badge/" alt="Docs"></a>
+  <a href="https://pypi.org/project/nautobot-trax/"><img src="https://img.shields.io/pypi/v/nautobot-trax" alt="PyPI version"></a>
+  <a href="https://pypi.org/project/nautobot-trax/"><img src="https://img.shields.io/pypi/dm/nautobot-trax" alt="PyPI downloads"></a>
+  <br>
+  A Nautobot App for tactical mission communications planning, SATCOM transport, and deployable network package execution.
+</p>
+
+## Overview
+
+Nautobot TRAX supports tactical mission communications by combining mission planning, SATCOM and Combat Net Radio (CNR) frequency coordination, and transport-path design into a single operational workflow. Teams can model and execute mission packages that span CNR, SATCOM, terrestrial transport, and constrained field-network conditions.
+
+The app links mission plans, transport options, frequency sets, operations, and supporting inventory so planners can coordinate PACE communications, map transport dependencies to real devices/circuits/providers, operational tracking, and prepare deployable tactical network packages with traceable data from planning through execution.
+
+## Release Status
+
+TRAX 0.1.x is an early release series. Pin the version used in your environment
+and review migration requirements before upgrading. Interfaces and data models
+may continue to evolve before version 1.0.
+
+## Compatibility
+
+- Nautobot: >= 3.1.8, < 4.0.0
+- Python: >= 3.10, < 3.14; hardened Operational Map archive processing requires Python 3.11+
+
+## Installation
+
+Install from PyPI:
+
+```shell
+pip install nautobot-trax
+```
+
+Pin a specific release:
+
+```shell
+pip install nautobot-trax==0.1.0
+```
+
+To keep the app installed during Nautobot upgrades, add it to local requirements:
+
+```shell
+echo nautobot-trax >> local_requirements.txt
+```
+
+## Enable in Nautobot
+
+Add the app to your Nautobot configuration:
+
+```python
+PLUGINS = ["nautobot_trax"]
+
+# Optional plugin settings
+# PLUGINS_CONFIG = {
+#     "nautobot_trax": {
+#         # Add settings here
+#     }
+# }
+```
+
+Run migrations and post-upgrade tasks:
+
+```shell
+nautobot-server post_upgrade
+```
+
+Restart Nautobot services after installation or upgrade.
+
+## Documentation
+
+- User Guide: https://docs.nautobot.com/projects/nautobot-trax/en/latest/user/app_overview/
+- Administrator Guide: https://docs.nautobot.com/projects/nautobot-trax/en/latest/admin/install/
+- Developer Guide: https://docs.nautobot.com/projects/nautobot-trax/en/latest/dev/contributing/
+- Release Notes: https://docs.nautobot.com/projects/nautobot-trax/en/latest/admin/release_notes/
+- FAQ: https://docs.nautobot.com/projects/nautobot-trax/en/latest/user/faq/
+
+## Contributing
+
+Contributions are welcome. For development setup and workflows, see:
+
+- https://docs.nautobot.com/projects/nautobot-trax/en/latest/dev/dev_environment/
+- https://docs.nautobot.com/projects/nautobot-trax/en/latest/dev/contributing/
+
+## Support
+
+For questions, start with the FAQ and then reach out in the Network to Code Slack #nautobot channel:
+
+- http://slack.networktocode.com/
+
+## Operational Map deployment
+
+Configure persistent private atlas storage before uploading basemaps. Existing
+atlases require the private-storage migration with their original media mounted.
+See the [Operational Map guide](https://github.com/d-camacho/nautobot-app-trax/blob/main/docs/user/operational_map.md) for storage, upgrade,
+query limits, and permissions. Demo operator provisioning is an explicit opt-in;
+the supplied development configuration enables it, while normal installs do not.
+

nautobot_trax-0.1.0/README.md

@@ -0,0 +1,101 @@
+# Nautobot TRAX
+
+<p align="center">
+  <img src="https://github.com/d-camacho/nautobot-app-trax/blob/main/docs/images/trax_full.png" class="logo" height="400px" alt="Nautobot TRAX logo">
+  <br>
+  <a href="https://github.com/nautobot/nautobot-app-nautobot-trax/actions"><img src="https://github.com/nautobot/nautobot-app-nautobot-trax/actions/workflows/ci.yml/badge.svg?branch=main" alt="CI"></a>
+  <a href="https://docs.nautobot.com/projects/nautobot-trax/en/latest/"><img src="https://readthedocs.org/projects/nautobot-app-nautobot-trax/badge/" alt="Docs"></a>
+  <a href="https://pypi.org/project/nautobot-trax/"><img src="https://img.shields.io/pypi/v/nautobot-trax" alt="PyPI version"></a>
+  <a href="https://pypi.org/project/nautobot-trax/"><img src="https://img.shields.io/pypi/dm/nautobot-trax" alt="PyPI downloads"></a>
+  <br>
+  A Nautobot App for tactical mission communications planning, SATCOM transport, and deployable network package execution.
+</p>
+
+## Overview
+
+Nautobot TRAX supports tactical mission communications by combining mission planning, SATCOM and Combat Net Radio (CNR) frequency coordination, and transport-path design into a single operational workflow. Teams can model and execute mission packages that span CNR, SATCOM, terrestrial transport, and constrained field-network conditions.
+
+The app links mission plans, transport options, frequency sets, operations, and supporting inventory so planners can coordinate PACE communications, map transport dependencies to real devices/circuits/providers, operational tracking, and prepare deployable tactical network packages with traceable data from planning through execution.
+
+## Release Status
+
+TRAX 0.1.x is an early release series. Pin the version used in your environment
+and review migration requirements before upgrading. Interfaces and data models
+may continue to evolve before version 1.0.
+
+## Compatibility
+
+- Nautobot: >= 3.1.8, < 4.0.0
+- Python: >= 3.10, < 3.14; hardened Operational Map archive processing requires Python 3.11+
+
+## Installation
+
+Install from PyPI:
+
+```shell
+pip install nautobot-trax
+```
+
+Pin a specific release:
+
+```shell
+pip install nautobot-trax==0.1.0
+```
+
+To keep the app installed during Nautobot upgrades, add it to local requirements:
+
+```shell
+echo nautobot-trax >> local_requirements.txt
+```
+
+## Enable in Nautobot
+
+Add the app to your Nautobot configuration:
+
+```python
+PLUGINS = ["nautobot_trax"]
+
+# Optional plugin settings
+# PLUGINS_CONFIG = {
+#     "nautobot_trax": {
+#         # Add settings here
+#     }
+# }
+```
+
+Run migrations and post-upgrade tasks:
+
+```shell
+nautobot-server post_upgrade
+```
+
+Restart Nautobot services after installation or upgrade.
+
+## Documentation
+
+- User Guide: https://docs.nautobot.com/projects/nautobot-trax/en/latest/user/app_overview/
+- Administrator Guide: https://docs.nautobot.com/projects/nautobot-trax/en/latest/admin/install/
+- Developer Guide: https://docs.nautobot.com/projects/nautobot-trax/en/latest/dev/contributing/
+- Release Notes: https://docs.nautobot.com/projects/nautobot-trax/en/latest/admin/release_notes/
+- FAQ: https://docs.nautobot.com/projects/nautobot-trax/en/latest/user/faq/
+
+## Contributing
+
+Contributions are welcome. For development setup and workflows, see:
+
+- https://docs.nautobot.com/projects/nautobot-trax/en/latest/dev/dev_environment/
+- https://docs.nautobot.com/projects/nautobot-trax/en/latest/dev/contributing/
+
+## Support
+
+For questions, start with the FAQ and then reach out in the Network to Code Slack #nautobot channel:
+
+- http://slack.networktocode.com/
+
+## Operational Map deployment
+
+Configure persistent private atlas storage before uploading basemaps. Existing
+atlases require the private-storage migration with their original media mounted.
+See the [Operational Map guide](https://github.com/d-camacho/nautobot-app-trax/blob/main/docs/user/operational_map.md) for storage, upgrade,
+query limits, and permissions. Demo operator provisioning is an explicit opt-in;
+the supplied development configuration enables it, while normal installs do not.

nautobot_trax-0.1.0/nautobot_trax/__init__.py

@@ -0,0 +1,53 @@
+"""App declaration for nautobot_trax."""
+
+from importlib import metadata
+
+from nautobot.apps import NautobotAppConfig
+
+__version__ = metadata.version(__name__)
+
+
+class NautobotTraxConfig(NautobotAppConfig):
+    """App configuration for the TRAX app."""
+
+    name = "nautobot_trax"
+    verbose_name = "TRAX"
+    version = __version__
+    author = "TRAX"
+    description = "TRAX mission planning app with integrated frequency management and mission domain models."
+    base_url = "nautobot-trax"
+    min_version = "3.1.8"
+    required_settings = []
+    default_settings = {
+        "enable_demo_user": False,
+        "map_storage_root": "",
+        "map_max_upload_bytes": 5 * 1024**3,
+        "map_validation_timeout": 30,
+        "map_tile_timeout": 2,
+    }
+    docs_view_name = "plugins:nautobot_trax:docs"
+    searchable_models = [
+        "operation",
+        "missionplan",
+        "missiontransportoption",
+        "frequencyband",
+        "frequency",
+        "satellite",
+        "missionfrequencyset",
+        "maptileset",
+    ]
+
+    def ready(self):  # pylint: disable=import-outside-toplevel
+        """Register post-migrate seed hook."""
+        # These imports must wait for Django's model registry to be ready.
+        # pylint: disable=import-outside-toplevel
+        super().ready()
+
+        from django.db.models.signals import post_migrate
+
+        from nautobot_trax.seed import post_migrate_seed_operator_user
+
+        post_migrate.connect(post_migrate_seed_operator_user, sender=self)
+
+
+config = NautobotTraxConfig  # pylint: disable=invalid-name  # Required Nautobot entry point.

nautobot_trax-0.1.0/nautobot_trax/api/__init__.py

@@ -0,0 +1 @@
+"""REST API module for nautobot_trax app."""

nautobot_trax-0.1.0/nautobot_trax/api/serializers.py

@@ -0,0 +1,368 @@
+"""API serializers for nautobot_trax."""
+
+from django.urls import reverse
+from nautobot.apps.api import NautobotModelSerializer, TaggedModelSerializerMixin
+from rest_framework import serializers
+
+from nautobot_trax import models
+
+# ---------------------------------------------------------------------------
+# Frequency Management serializers
+# ---------------------------------------------------------------------------
+
+
+class FrequencyBandSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
+    """FrequencyBand serializer (read-only reference data)."""
+
+    class Meta:
+        """Declare the model and fields exposed through the API."""
+
+        model = models.FrequencyBand
+        fields = [
+            "id",
+            "object_type",
+            "display",
+            "url",
+            "natural_slug",
+            "name",
+            "description",
+            "lower_frequency_mhz",
+            "upper_frequency_mhz",
+            "created",
+            "last_updated",
+            "tags",
+            "custom_fields",
+            "computed_fields",
+            "relationships",
+        ]
+        read_only_fields = ["lower_frequency_mhz", "upper_frequency_mhz"]
+
+
+class SatelliteSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
+    """Satellite serializer."""
+
+    class Meta:
+        """Declare the model and fields exposed through the API."""
+
+        model = models.Satellite
+        fields = [
+            "id",
+            "object_type",
+            "display",
+            "url",
+            "natural_slug",
+            "name",
+            "is_geostationary",
+            "orbit",
+            "description",
+            "provider",
+            "created",
+            "last_updated",
+            "tags",
+            "notes_url",
+            "custom_fields",
+            "computed_fields",
+            "relationships",
+        ]
+
+
+class FrequencySetSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):  # pylint: disable=nb-sub-class-name
+    """FrequencySet serializer."""
+
+    class Meta:
+        """Declare the model and fields exposed through the API."""
+
+        model = models.MissionFrequencySet
+        fields = [
+            "id",
+            "object_type",
+            "display",
+            "url",
+            "natural_slug",
+            "name",
+            "tx_frequency_mhz",
+            "rx_frequency_mhz",
+            "tx_bandwidth_mhz",
+            "rx_bandwidth_mhz",
+            "transport_type",
+            "transport_subtype",
+            "access_method",
+            "modulation",
+            "polarization",
+            "notes",
+            "satellite",
+            "band",
+            "provider",
+            "status",
+            "tenant",
+            "created",
+            "last_updated",
+            "tags",
+            "notes_url",
+            "custom_fields",
+            "computed_fields",
+            "relationships",
+        ]
+
+
+MissionFrequencySetSerializer = FrequencySetSerializer
+
+
+class FrequencySerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
+    """Frequency serializer."""
+
+    class Meta:
+        """Declare the model and fields exposed through the API."""
+
+        model = models.Frequency
+        fields = [
+            "id",
+            "object_type",
+            "display",
+            "url",
+            "natural_slug",
+            "frequency_mhz",
+            "description",
+            "band",
+            "status",
+            "tenant",
+            "created",
+            "last_updated",
+            "tags",
+            "notes_url",
+            "custom_fields",
+            "computed_fields",
+            "relationships",
+        ]
+
+
+# ---------------------------------------------------------------------------
+# Mission Planning serializers
+# ---------------------------------------------------------------------------
+
+
+class MissionPlanSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
+    """MissionPlan serializer."""
+
+    def validate(self, attrs):
+        """Validate the final kit selections, including partial updates."""
+        tenant = attrs.get("tenant", self.instance.tenant if self.instance else None)
+        supporting_kits = attrs.get("supporting_kits")
+        if supporting_kits is None:
+            supporting_kits = self.instance.supporting_kits.all() if self.instance else []
+        if tenant and tenant in supporting_kits:
+            raise serializers.ValidationError(
+                {"supporting_kits": "Do not include the deployed kit in supporting kits."}
+            )
+        return super().validate(attrs)
+
+    class Meta:
+        """Declare the model and fields exposed through the API."""
+
+        model = models.MissionPlan
+        fields = [
+            "id",
+            "object_type",
+            "display",
+            "url",
+            "natural_slug",
+            "mission_name",
+            "tenant",
+            "supporting_kits",
+            "status",
+            "start_date",
+            "end_date",
+            "location",
+            "deployment_mgrs",
+            "deployment_latitude",
+            "deployment_longitude",
+            "deployment_altitude_m",
+            "description",
+            "created",
+            "last_updated",
+            "tags",
+            "notes_url",
+            "custom_fields",
+            "computed_fields",
+            "relationships",
+        ]
+
+
+class OperationSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
+    """Operation serializer."""
+
+    class Meta:
+        """Declare the model and fields exposed through the API."""
+
+        model = models.Operation
+        fields = [
+            "id",
+            "object_type",
+            "display",
+            "url",
+            "natural_slug",
+            "name",
+            "status",
+            "start_date",
+            "end_date",
+            "poc",
+            "unit_tasked",
+            "aor",
+            "description",
+            "mission_plans",
+            "created",
+            "last_updated",
+            "tags",
+            "notes_url",
+            "custom_fields",
+            "computed_fields",
+            "relationships",
+        ]
+
+
+class MissionTransportOptionSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
+    """MissionTransportOption serializer."""
+
+    class Meta:
+        """Declare the model and fields exposed through the API."""
+
+        model = models.MissionTransportOption
+        fields = [
+            "id",
+            "object_type",
+            "display",
+            "url",
+            "natural_slug",
+            "name",
+            "transport_type",
+            "transport_subtype",
+            "role",
+            "polarization",
+            "status",
+            "notes",
+            "mission_plan",
+            "circuit",
+            "device",
+            "provider",
+            "mission_frequency_set",
+            "satellite",
+            "created",
+            "last_updated",
+            "tags",
+            "notes_url",
+            "custom_fields",
+            "computed_fields",
+            "relationships",
+        ]
+
+
+class CommsCardSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
+    """CommsCard serializer."""
+
+    class Meta:
+        """Declare the model and fields exposed through the API."""
+
+        model = models.CommsCard
+        fields = [
+            "id",
+            "object_type",
+            "display",
+            "url",
+            "natural_slug",
+            "name",
+            "operation",
+            "created",
+            "last_updated",
+            "tags",
+            "notes_url",
+            "custom_fields",
+            "computed_fields",
+            "relationships",
+        ]
+
+
+class CommsCardEntrySerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
+    """CommsCardEntry serializer."""
+
+    class Meta:
+        """Declare the model and fields exposed through the API."""
+
+        model = models.CommsCardEntry
+        fields = [
+            "id",
+            "object_type",
+            "display",
+            "url",
+            "natural_slug",
+            "channel",
+            "keymat",
+            "comms_card",
+            "frequency_set",
+            "created",
+            "last_updated",
+            "tags",
+            "notes_url",
+            "custom_fields",
+            "computed_fields",
+            "relationships",
+        ]
+
+
+# ---------------------------------------------------------------------------
+# Operational Map serializers
+# ---------------------------------------------------------------------------
+
+
+class MapTileSetSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
+    """MapTileSet serializer."""
+
+    def to_representation(self, instance):
+        """Return the object-authorized REST download route for uploaded archives."""
+        data = super().to_representation(instance)
+        if instance.mbtiles_file:
+            url = reverse("plugins-api:nautobot_trax-api:maptileset-download", kwargs={"pk": instance.pk})
+            request = self.context.get("request")
+            data["mbtiles_file"] = request.build_absolute_uri(url) if request else url
+        return data
+
+    class Meta:
+        """Define atlas metadata and read-only derived values."""
+
+        model = models.MapTileSet
+        fields = [
+            "id",
+            "object_type",
+            "display",
+            "url",
+            "natural_slug",
+            "name",
+            "description",
+            "mbtiles_file",
+            "is_active",
+            "tile_format",
+            "attribution",
+            "min_zoom",
+            "max_zoom",
+            "zoom_levels",
+            "bounds_west",
+            "bounds_south",
+            "bounds_east",
+            "bounds_north",
+            "created",
+            "last_updated",
+            "tags",
+            "custom_fields",
+            "computed_fields",
+            "relationships",
+        ]
+        read_only_fields = [
+            "tile_format",
+            "attribution",
+            "min_zoom",
+            "max_zoom",
+            "zoom_levels",
+            "bounds_west",
+            "bounds_south",
+            "bounds_east",
+            "bounds_north",
+        ]

nautobot_trax-0.1.0/nautobot_trax/api/urls.py

@@ -0,0 +1,20 @@
+"""Django API urlpatterns declaration for nautobot_trax app."""
+
+from nautobot.apps.api import OrderedDefaultRouter
+
+from nautobot_trax.api import views
+
+router = OrderedDefaultRouter()
+router.register("frequency-bands", views.FrequencyBandViewSet)
+router.register("frequencies", views.FrequencyViewSet)
+router.register("satellites", views.SatelliteViewSet)
+router.register("frequency-sets", views.FrequencySetViewSet)
+router.register("operations", views.OperationViewSet)
+router.register("mission-plans", views.MissionPlanViewSet)
+router.register("mission-transport-options", views.MissionTransportOptionViewSet)
+router.register("comms-cards", views.CommsCardViewSet)
+router.register("comms-card-entries", views.CommsCardEntryViewSet)
+router.register("map-tile-sets", views.MapTileSetViewSet)
+
+app_name = "nautobot_trax-api"
+urlpatterns = router.urls