nautobot-dns-models 0.2.0__tar.gz

nautobot_dns_models-0.2.0/LICENSE

@@ -0,0 +1,15 @@
+Apache Software License 2.0
+
+Copyright (c) 2025, 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_dns_models-0.2.0/PKG-INFO

@@ -0,0 +1,77 @@
+Metadata-Version: 2.3
+Name: nautobot-dns-models
+Version: 0.2.0
+Summary: Nautobot DNS Models
+License: Apache-2.0
+Keywords: nautobot,nautobot-app,nautobot-plugin
+Author: Network to Code, LLC
+Author-email: info@networktocode.com
+Requires-Python: >=3.9,<3.13
+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.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Provides-Extra: all
+Requires-Dist: nautobot (>=2.4.4,<3.0.0)
+Project-URL: Documentation, https://docs.nautobot.com/projects/nautobot-dns-models/en/latest/
+Project-URL: Homepage, https://github.com/nautobot/nautobot-app-dns-models
+Project-URL: Repository, https://github.com/nautobot/nautobot-app-dns-models
+Description-Content-Type: text/markdown
+
+# Nautobot DNS Models
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/nautobot/nautobot-app-dns-models/develop/docs/images/icon-nautobot-dns-models.png" class="logo" height="200px">
+  <br>
+  <a href="https://github.com/nautobot/nautobot-app-dns-models/actions"><img src="https://github.com/nautobot/nautobot-app-dns-models/actions/workflows/ci.yml/badge.svg?branch=main"></a>
+  <a href="https://docs.nautobot.com/projects/dns-models/en/latest"><img src="https://readthedocs.org/projects/nautobot-app-dns-models/badge/"></a>
+  <a href="https://pypi.org/project/nautobot-dns-models/"><img src="https://img.shields.io/pypi/v/nautobot-dns-models"></a>
+  <a href="https://pypi.org/project/nautobot-dns-models/"><img src="https://img.shields.io/pypi/dm/nautobot-dns-models"></a>
+  <br>
+  An <a href="https://www.networktocode.com/nautobot/apps/">App</a> for <a href="https://nautobot.com/">Nautobot</a>.
+</p>
+
+## Overview
+
+The DNS models app adds specific DNS related models for managing DNS zones and records to Nautobot. The goal is to be able to manage a DNS configuration for a zone or sub-zone. These models can then be leveraged with 3rd party IPAM or DNS services in line with the rest of your network data.
+
+### Screenshots
+
+More screenshots can be found in the [Using the App](https://docs.nautobot.com/projects/dns-models/en/latest/user/app_use_cases/) page in the documentation. Here's a quick overview of some of the app's added functionality:
+
+![Zone List View](https://raw.githubusercontent.com/nautobot/nautobot-app-dns-models/develop/docs/images/readme-1.png)
+
+![Adding a DNS Zone](https://raw.githubusercontent.com/nautobot/nautobot-app-dns-models/develop/docs/images/getting_started-add-zone-3.png)
+
+Adding a DNS Zone
+
+![DNS Zone View](https://raw.githubusercontent.com/nautobot/nautobot-app-dns-models/develop/docs/images/getting_started-add-record-3.png)
+
+The DNS Zone View
+
+## Documentation
+
+Full documentation for this App can be found over on the [Nautobot Docs](https://docs.nautobot.com) website:
+
+- [User Guide](https://docs.nautobot.com/projects/dns-models/en/latest/user/app_overview/) - Overview, Using the App, Getting Started.
+- [Administrator Guide](https://docs.nautobot.com/projects/dns-models/en/latest/admin/install/) - How to Install, Configure, Upgrade, or Uninstall the App.
+- [Developer Guide](https://docs.nautobot.com/projects/dns-models/en/latest/dev/contributing/) - Extending the App, Code Reference, Contribution Guide.
+- [Release Notes / Changelog](https://docs.nautobot.com/projects/dns-models/en/latest/admin/release_notes/).
+- [Frequently Asked Questions](https://docs.nautobot.com/projects/dns-models/en/latest/user/faq/).
+
+### Contributing to the Documentation
+
+You can find all the Markdown source for the App documentation under the [`docs`](https://github.com/nautobot/nautobot-app-dns-models/tree/develop/docs) folder in this repository. For simple edits, a Markdown capable editor is sufficient: clone the repository and edit away.
+
+If you need to view the fully-generated documentation site, you can build it with [MkDocs](https://www.mkdocs.org/). A container hosting the documentation can be started using the `invoke` commands (details in the [Development Environment Guide](https://docs.nautobot.com/projects/dns-models/en/latest/dev/dev_environment/#docker-development-environment)) on [http://localhost:8001](http://localhost:8001). Using this container, as your changes to the documentation are saved, they will be automatically rebuilt and any pages currently being viewed will be reloaded in your browser.
+
+Any PRs with fixes or improvements are very welcome!
+
+## Questions
+
+For any questions or comments, please check the [FAQ](https://docs.nautobot.com/projects/dns-models/en/latest/user/faq/) first. Feel free to also swing by the [Network to Code Slack](https://networktocode.slack.com/) (channel `#nautobot`), sign up [here](http://slack.networktocode.com/) if you don't have an account.
+

nautobot_dns_models-0.2.0/README.md

@@ -0,0 +1,52 @@
+# Nautobot DNS Models
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/nautobot/nautobot-app-dns-models/develop/docs/images/icon-nautobot-dns-models.png" class="logo" height="200px">
+  <br>
+  <a href="https://github.com/nautobot/nautobot-app-dns-models/actions"><img src="https://github.com/nautobot/nautobot-app-dns-models/actions/workflows/ci.yml/badge.svg?branch=main"></a>
+  <a href="https://docs.nautobot.com/projects/dns-models/en/latest"><img src="https://readthedocs.org/projects/nautobot-app-dns-models/badge/"></a>
+  <a href="https://pypi.org/project/nautobot-dns-models/"><img src="https://img.shields.io/pypi/v/nautobot-dns-models"></a>
+  <a href="https://pypi.org/project/nautobot-dns-models/"><img src="https://img.shields.io/pypi/dm/nautobot-dns-models"></a>
+  <br>
+  An <a href="https://www.networktocode.com/nautobot/apps/">App</a> for <a href="https://nautobot.com/">Nautobot</a>.
+</p>
+
+## Overview
+
+The DNS models app adds specific DNS related models for managing DNS zones and records to Nautobot. The goal is to be able to manage a DNS configuration for a zone or sub-zone. These models can then be leveraged with 3rd party IPAM or DNS services in line with the rest of your network data.
+
+### Screenshots
+
+More screenshots can be found in the [Using the App](https://docs.nautobot.com/projects/dns-models/en/latest/user/app_use_cases/) page in the documentation. Here's a quick overview of some of the app's added functionality:
+
+![Zone List View](https://raw.githubusercontent.com/nautobot/nautobot-app-dns-models/develop/docs/images/readme-1.png)
+
+![Adding a DNS Zone](https://raw.githubusercontent.com/nautobot/nautobot-app-dns-models/develop/docs/images/getting_started-add-zone-3.png)
+
+Adding a DNS Zone
+
+![DNS Zone View](https://raw.githubusercontent.com/nautobot/nautobot-app-dns-models/develop/docs/images/getting_started-add-record-3.png)
+
+The DNS Zone View
+
+## Documentation
+
+Full documentation for this App can be found over on the [Nautobot Docs](https://docs.nautobot.com) website:
+
+- [User Guide](https://docs.nautobot.com/projects/dns-models/en/latest/user/app_overview/) - Overview, Using the App, Getting Started.
+- [Administrator Guide](https://docs.nautobot.com/projects/dns-models/en/latest/admin/install/) - How to Install, Configure, Upgrade, or Uninstall the App.
+- [Developer Guide](https://docs.nautobot.com/projects/dns-models/en/latest/dev/contributing/) - Extending the App, Code Reference, Contribution Guide.
+- [Release Notes / Changelog](https://docs.nautobot.com/projects/dns-models/en/latest/admin/release_notes/).
+- [Frequently Asked Questions](https://docs.nautobot.com/projects/dns-models/en/latest/user/faq/).
+
+### Contributing to the Documentation
+
+You can find all the Markdown source for the App documentation under the [`docs`](https://github.com/nautobot/nautobot-app-dns-models/tree/develop/docs) folder in this repository. For simple edits, a Markdown capable editor is sufficient: clone the repository and edit away.
+
+If you need to view the fully-generated documentation site, you can build it with [MkDocs](https://www.mkdocs.org/). A container hosting the documentation can be started using the `invoke` commands (details in the [Development Environment Guide](https://docs.nautobot.com/projects/dns-models/en/latest/dev/dev_environment/#docker-development-environment)) on [http://localhost:8001](http://localhost:8001). Using this container, as your changes to the documentation are saved, they will be automatically rebuilt and any pages currently being viewed will be reloaded in your browser.
+
+Any PRs with fixes or improvements are very welcome!
+
+## Questions
+
+For any questions or comments, please check the [FAQ](https://docs.nautobot.com/projects/dns-models/en/latest/user/faq/) first. Feel free to also swing by the [Network to Code Slack](https://networktocode.slack.com/) (channel `#nautobot`), sign up [here](http://slack.networktocode.com/) if you don't have an account.

nautobot_dns_models-0.2.0/nautobot_dns_models/__init__.py

@@ -0,0 +1,32 @@
+"""Plugin declaration for nautobot_dns_models."""
+
+# Metadata is inherited from Nautobot. If not including Nautobot in the environment, this should be added
+try:
+    from importlib import metadata
+except ImportError:
+    # Python version < 3.8
+    import importlib_metadata as metadata
+
+__version__ = metadata.version(__name__)
+
+from nautobot.apps import NautobotAppConfig
+
+
+class NautobotDnsModelsConfig(NautobotAppConfig):
+    """Plugin configuration for the nautobot_dns_models plugin."""
+
+    name = "nautobot_dns_models"
+    verbose_name = "Nautobot DNS Models"
+    version = __version__
+    author = "Network to Code, LLC"
+    description = "Nautobot DNS Models."
+    base_url = "dns"
+    required_settings = []
+    min_version = "2.4.0"
+    max_version = "2.9999"
+    default_settings = {}
+    caching_config = {}
+    docs_view_name = "plugins:nautobot_dns_models:docs"
+
+
+config = NautobotDnsModelsConfig  # pylint:disable=invalid-name

nautobot_dns_models-0.2.0/nautobot_dns_models/api/__init__.py

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

nautobot_dns_models-0.2.0/nautobot_dns_models/api/serializers.py

@@ -0,0 +1,126 @@
+"""API serializers for nautobot_dns_models."""
+
+from nautobot.apps.api import NautobotModelSerializer
+from rest_framework import serializers
+
+from nautobot_dns_models import models
+
+
+class DNSZoneModelSerializer(NautobotModelSerializer):  # pylint: disable=too-many-ancestors
+    """DnsZoneModel Serializer."""
+
+    url = serializers.HyperlinkedIdentityField(view_name="plugins-api:nautobot_dns_models-api:dnszonemodel-detail")
+
+    class Meta:
+        """Meta attributes."""
+
+        model = models.DNSZoneModel
+        fields = "__all__"
+
+        # Option for disabling write for certain fields:
+        # read_only_fields = []
+
+
+class NSRecordModelSerializer(NautobotModelSerializer):  # pylint: disable=too-many-ancestors
+    """NSRecordModel Serializer."""
+
+    url = serializers.HyperlinkedIdentityField(view_name="plugins-api:nautobot_dns_models-api:nsrecordmodel-detail")
+
+    class Meta:
+        """Meta attributes."""
+
+        model = models.NSRecordModel
+        fields = "__all__"
+
+        # Option for disabling write for certain fields:
+        # read_only_fields = []
+
+
+class ARecordModelSerializer(NautobotModelSerializer):  # pylint: disable=too-many-ancestors
+    """ARecordModel Serializer."""
+
+    url = serializers.HyperlinkedIdentityField(view_name="plugins-api:nautobot_dns_models-api:arecordmodel-detail")
+
+    class Meta:
+        """Meta attributes."""
+
+        model = models.ARecordModel
+        fields = "__all__"
+
+        # Option for disabling write for certain fields:
+        # read_only_fields = []
+
+
+class AAAARecordModelSerializer(NautobotModelSerializer):  # pylint: disable=too-many-ancestors
+    """AAAARecordModel Serializer."""
+
+    url = serializers.HyperlinkedIdentityField(view_name="plugins-api:nautobot_dns_models-api:aaaarecordmodel-detail")
+
+    class Meta:
+        """Meta attributes."""
+
+        model = models.AAAARecordModel
+        fields = "__all__"
+
+        # Option for disabling write for certain fields:
+        # read_only_fields = []
+
+
+class CNAMERecordModelSerializer(NautobotModelSerializer):  # pylint: disable=too-many-ancestors
+    """CNAMERecordModel Serializer."""
+
+    url = serializers.HyperlinkedIdentityField(view_name="plugins-api:nautobot_dns_models-api:cnamerecordmodel-detail")
+
+    class Meta:
+        """Meta attributes."""
+
+        model = models.CNAMERecordModel
+        fields = "__all__"
+
+        # Option for disabling write for certain fields:
+        # read_only_fields = []
+
+
+class MXRecordModelSerializer(NautobotModelSerializer):  # pylint: disable=too-many-ancestors
+    """MXRecordModel Serializer."""
+
+    url = serializers.HyperlinkedIdentityField(view_name="plugins-api:nautobot_dns_models-api:mxrecordmodel-detail")
+
+    class Meta:
+        """Meta attributes."""
+
+        model = models.MXRecordModel
+        fields = "__all__"
+
+        # Option for disabling write for certain fields:
+        # read_only_fields = []
+
+
+class TXTRecordModelSerializer(NautobotModelSerializer):  # pylint: disable=too-many-ancestors
+    """TXTRecordModel Serializer."""
+
+    url = serializers.HyperlinkedIdentityField(view_name="plugins-api:nautobot_dns_models-api:txtrecordmodel-detail")
+
+    class Meta:
+        """Meta attributes."""
+
+        model = models.TXTRecordModel
+        fields = "__all__"
+
+        # Option for disabling write for certain fields:
+        # read_only_fields = []
+
+
+class PTRRecordModelSerializer(NautobotModelSerializer):  # pylint: disable=too-many-ancestors
+    """PTRRecordModel Serializer."""
+
+    url = serializers.HyperlinkedIdentityField(view_name="plugins-api:nautobot_dns_models-api:ptrrecordmodel-detail")
+
+    class Meta:
+        """Meta attributes."""
+
+        model = models.PTRRecordModel
+        fields = "__all__"
+
+        # Option for disabling write for certain fields:
+        # read_only_fields = []

nautobot_dns_models-0.2.0/nautobot_dns_models/api/urls.py

@@ -0,0 +1,18 @@
+"""Django API urlpatterns declaration for nautobot_dns_models plugin."""
+
+from nautobot.apps.api import OrderedDefaultRouter
+
+from nautobot_dns_models.api import views
+
+router = OrderedDefaultRouter()
+# add the name of your api endpoint, usually hyphenated model name in plural, e.g. "my-model-classes"
+router.register("dns-zones", views.DNSZoneModelViewSet)
+router.register("ns-records", views.NSRecordModelViewSet)
+router.register("a-records", views.ARecordModelViewSet)
+router.register("aaaa-records", views.AAAARecordModelViewSet)
+router.register("cname-records", views.CNameRecordModelViewSet)
+router.register("mx-records", views.MXRecordModelViewSet)
+router.register("txt-records", views.TXTRecordModelViewSet)
+router.register("ptr-records", views.PTRRecordModelViewSet)
+
+urlpatterns = router.urls

nautobot_dns_models-0.2.0/nautobot_dns_models/api/views.py

@@ -0,0 +1,116 @@
+"""API views for nautobot_dns_models."""
+
+from nautobot.apps.api import NautobotModelViewSet
+
+from nautobot_dns_models.api.serializers import (
+    AAAARecordModelSerializer,
+    ARecordModelSerializer,
+    CNAMERecordModelSerializer,
+    DNSZoneModelSerializer,
+    MXRecordModelSerializer,
+    NSRecordModelSerializer,
+    PTRRecordModelSerializer,
+    TXTRecordModelSerializer,
+)
+from nautobot_dns_models.filters import (
+    AAAARecordModelFilterSet,
+    ARecordModelFilterSet,
+    CNAMERecordModelFilterSet,
+    DNSZoneModelFilterSet,
+    MXRecordModelFilterSet,
+    NSRecordModelFilterSet,
+    PTRRecordModelFilterSet,
+    TXTRecordModelFilterSet,
+)
+from nautobot_dns_models.models import (
+    AAAARecordModel,
+    ARecordModel,
+    CNAMERecordModel,
+    DNSZoneModel,
+    MXRecordModel,
+    NSRecordModel,
+    PTRRecordModel,
+    TXTRecordModel,
+)
+
+
+class DNSZoneModelViewSet(NautobotModelViewSet):  # pylint: disable=too-many-ancestors
+    """DnsZoneModel API ViewSet."""
+
+    queryset = DNSZoneModel.objects.all()
+    serializer_class = DNSZoneModelSerializer
+    filterset_class = DNSZoneModelFilterSet
+
+    lookup_field = "pk"
+    # Option for modifying the default HTTP methods:
+    # http_method_names = ["get", "post", "put", "patch", "delete", "head", "options", "trace"]
+
+
+class NSRecordModelViewSet(NautobotModelViewSet):  # pylint: disable=too-many-ancestors
+    """NSRecordModel API ViewSet."""
+
+    queryset = NSRecordModel.objects.all()
+    serializer_class = NSRecordModelSerializer
+    filterset_class = NSRecordModelFilterSet
+
+    lookup_field = "pk"
+
+
+class ARecordModelViewSet(NautobotModelViewSet):  # pylint: disable=too-many-ancestors
+    """ARecordModel API ViewSet."""
+
+    queryset = ARecordModel.objects.all()
+    serializer_class = ARecordModelSerializer
+    filterset_class = ARecordModelFilterSet
+
+    lookup_field = "pk"
+
+
+class AAAARecordModelViewSet(NautobotModelViewSet):  # pylint: disable=too-many-ancestors
+    """AAAARecordModel API ViewSet."""
+
+    queryset = AAAARecordModel.objects.all()
+    serializer_class = AAAARecordModelSerializer
+    filterset_class = AAAARecordModelFilterSet
+
+    lookup_field = "pk"
+
+
+class CNameRecordModelViewSet(NautobotModelViewSet):  # pylint: disable=too-many-ancestors
+    """CNameRecordModel API ViewSet."""
+
+    queryset = CNAMERecordModel.objects.all()
+    serializer_class = CNAMERecordModelSerializer
+    filterset_class = CNAMERecordModelFilterSet
+
+    lookup_field = "pk"
+
+
+class MXRecordModelViewSet(NautobotModelViewSet):  # pylint: disable=too-many-ancestors
+    """MXRecordModel API ViewSet."""
+
+    queryset = MXRecordModel.objects.all()
+    serializer_class = MXRecordModelSerializer
+    filterset_class = MXRecordModelFilterSet
+
+    lookup_field = "pk"
+
+
+class TXTRecordModelViewSet(NautobotModelViewSet):  # pylint: disable=too-many-ancestors
+    """TXTRecordModel API ViewSet."""
+
+    queryset = TXTRecordModel.objects.all()
+    serializer_class = TXTRecordModelSerializer
+    filterset_class = TXTRecordModelFilterSet
+
+    lookup_field = "pk"
+
+
+class PTRRecordModelViewSet(NautobotModelViewSet):  # pylint: disable=too-many-ancestors
+    """PTRRecordModel API ViewSet."""
+
+    queryset = PTRRecordModel.objects.all()
+    serializer_class = PTRRecordModelSerializer
+    filterset_class = PTRRecordModelFilterSet
+
+    lookup_field = "pk"

nautobot_dns_models-0.2.0/nautobot_dns_models/app-config-schema.json

@@ -0,0 +1 @@
+true

nautobot_dns_models-0.2.0/nautobot_dns_models/filters.py

@@ -0,0 +1,85 @@
+"""Filtering for nautobot_dns_models."""
+
+from nautobot.extras.filters import NautobotFilterSet
+
+from nautobot_dns_models import models
+
+
+class DNSZoneModelFilterSet(NautobotFilterSet):
+    """Filter for DNSZoneModel."""
+
+    class Meta:
+        """Meta attributes for filter."""
+
+        model = models.DNSZoneModel
+        fields = "__all__"
+
+
+class NSRecordModelFilterSet(NautobotFilterSet):
+    """Filter for NSRecordModel."""
+
+    class Meta:
+        """Meta attributes for filter."""
+
+        model = models.NSRecordModel
+        fields = "__all__"
+
+
+class ARecordModelFilterSet(NautobotFilterSet):
+    """Filter for ARecordModel."""
+
+    class Meta:
+        """Meta attributes for filter."""
+
+        model = models.ARecordModel
+        fields = "__all__"
+
+
+class AAAARecordModelFilterSet(NautobotFilterSet):
+    """Filter for AAAARecordModel."""
+
+    class Meta:
+        """Meta attributes for filter."""
+
+        model = models.AAAARecordModel
+        fields = "__all__"
+
+
+class CNAMERecordModelFilterSet(NautobotFilterSet):
+    """Filter for CNAMERecordModel."""
+
+    class Meta:
+        """Meta attributes for filter."""
+
+        model = models.CNAMERecordModel
+        fields = "__all__"
+
+
+class MXRecordModelFilterSet(NautobotFilterSet):
+    """Filter for MXRecordModel."""
+
+    class Meta:
+        """Meta attributes for filter."""
+
+        model = models.MXRecordModel
+        fields = "__all__"
+
+
+class TXTRecordModelFilterSet(NautobotFilterSet):
+    """Filter for TXTRecordModel."""
+
+    class Meta:
+        """Meta attributes for filter."""
+
+        model = models.TXTRecordModel
+        fields = "__all__"
+
+
+class PTRRecordModelFilterSet(NautobotFilterSet):
+    """Filter for PTRRecordModel."""
+
+    class Meta:
+        """Meta attributes for filter."""
+
+        model = models.PTRRecordModel
+        fields = "__all__"