nautobot-dev-example 1.0.0__tar.gz

nautobot_dev_example-1.0.0/LICENSE

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

@@ -0,0 +1,76 @@
+Metadata-Version: 2.1
+Name: nautobot-dev-example
+Version: 1.0.0
+Summary: Nautobot App to demonstrate how to create a Nautobot App.
+Home-page: https://github.com/nautobot/nautobot-app-dev-example
+License: Apache-2.0
+Keywords: nautobot,nautobot-app,nautobot-plugin
+Author: Network to Code, LLC
+Author-email: opensource@networktocode.com
+Requires-Python: >=3.8,<3.12
+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.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Provides-Extra: all
+Requires-Dist: nautobot (>=2.0.0,<3.0.0)
+Project-URL: Documentation, https://docs.nautobot.com/projects/dev-example/en/latest/
+Project-URL: Repository, https://github.com/nautobot/nautobot-app-dev-example
+Description-Content-Type: text/markdown
+
+# Nautobot Dev Example App
+
+This application serves as a testbed for evaluating improvements to the [Nautobot App Cookiecutter Templates](https://github.com/nautobot/cookiecutter-nautobot-app). **DO NOT USE** this repository directly in production environments or to bootstrap a new app!
+
+For those wanting to develop a new Nautobot app, please use the [cookiecutter template](https://github.com/nautobot/cookiecutter-nautobot-app) as a starting point.
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/nautobot/nautobot-app-dev-example/develop/docs/images/icon-nautobot-dev-example.png" class="logo" height="200px">
+  <br>
+  <a href="https://github.com/nautobot/nautobot-app-dev-example/actions"><img src="https://github.com/nautobot/nautobot-app-dev-example/actions/workflows/ci.yml/badge.svg?branch=main"></a>
+  <a href="https://docs.nautobot.com/projects/dev-example/en/latest/"><img src="https://readthedocs.org/projects/nautobot-plugin-dev-example/badge/"></a>
+  <a href="https://pypi.org/project/nautobot-dev-example/"><img src="https://img.shields.io/pypi/v/nautobot-dev-example"></a>
+  <a href="https://pypi.org/project/nautobot-dev-example/"><img src="https://img.shields.io/pypi/dm/nautobot-dev-example"></a>
+  <br>
+  An <a href="https://networktocode.com/nautobot-apps/">App</a> for <a href="https://nautobot.com/">Nautobot</a>.
+</p>
+
+## Overview
+
+An example Nautobot app with multiple functions:
+
+- Acts as a Canary App to test enhancements to the Nautobot app [cookiecutter templates](https://github.com/nautobot/cookiecutter-nautobot-app).
+- Illustrates how to use the Nautobot app framework.
+
+### Screenshots
+
+More screenshots can be found in the [Using the App](https://docs.nautobot.com/projects/dev-example/en/latest/user/app_use_cases/) page in the documentation. Here's a quick overview of some of the app's added functionality:
+
+![](https://raw.githubusercontent.com/nautobot/nautobot-app-dev-example/develop/docs/images/placeholder.png)
+
+## 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/dev-example/en/latest/user/app_overview/) - Overview, Using the App, Getting Started.
+- [Administrator Guide](https://docs.nautobot.com/projects/dev-example/en/latest/admin/install/) - How to Install, Configure, Upgrade, or Uninstall the App.
+- [Developer Guide](https://docs.nautobot.com/projects/dev-example/en/latest/dev/contributing/) - Extending the App, Code Reference, Contribution Guide.
+- [Release Notes / Changelog](https://docs.nautobot.com/projects/dev-example/en/latest/admin/release_notes/).
+- [Frequently Asked Questions](https://docs.nautobot.com/projects/dev-example/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-dev-example/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/dev-example/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/dev-example/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_dev_example-1.0.0/README.md

@@ -0,0 +1,51 @@
+# Nautobot Dev Example App
+
+This application serves as a testbed for evaluating improvements to the [Nautobot App Cookiecutter Templates](https://github.com/nautobot/cookiecutter-nautobot-app). **DO NOT USE** this repository directly in production environments or to bootstrap a new app!
+
+For those wanting to develop a new Nautobot app, please use the [cookiecutter template](https://github.com/nautobot/cookiecutter-nautobot-app) as a starting point.
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/nautobot/nautobot-app-dev-example/develop/docs/images/icon-nautobot-dev-example.png" class="logo" height="200px">
+  <br>
+  <a href="https://github.com/nautobot/nautobot-app-dev-example/actions"><img src="https://github.com/nautobot/nautobot-app-dev-example/actions/workflows/ci.yml/badge.svg?branch=main"></a>
+  <a href="https://docs.nautobot.com/projects/dev-example/en/latest/"><img src="https://readthedocs.org/projects/nautobot-plugin-dev-example/badge/"></a>
+  <a href="https://pypi.org/project/nautobot-dev-example/"><img src="https://img.shields.io/pypi/v/nautobot-dev-example"></a>
+  <a href="https://pypi.org/project/nautobot-dev-example/"><img src="https://img.shields.io/pypi/dm/nautobot-dev-example"></a>
+  <br>
+  An <a href="https://networktocode.com/nautobot-apps/">App</a> for <a href="https://nautobot.com/">Nautobot</a>.
+</p>
+
+## Overview
+
+An example Nautobot app with multiple functions:
+
+- Acts as a Canary App to test enhancements to the Nautobot app [cookiecutter templates](https://github.com/nautobot/cookiecutter-nautobot-app).
+- Illustrates how to use the Nautobot app framework.
+
+### Screenshots
+
+More screenshots can be found in the [Using the App](https://docs.nautobot.com/projects/dev-example/en/latest/user/app_use_cases/) page in the documentation. Here's a quick overview of some of the app's added functionality:
+
+![](https://raw.githubusercontent.com/nautobot/nautobot-app-dev-example/develop/docs/images/placeholder.png)
+
+## 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/dev-example/en/latest/user/app_overview/) - Overview, Using the App, Getting Started.
+- [Administrator Guide](https://docs.nautobot.com/projects/dev-example/en/latest/admin/install/) - How to Install, Configure, Upgrade, or Uninstall the App.
+- [Developer Guide](https://docs.nautobot.com/projects/dev-example/en/latest/dev/contributing/) - Extending the App, Code Reference, Contribution Guide.
+- [Release Notes / Changelog](https://docs.nautobot.com/projects/dev-example/en/latest/admin/release_notes/).
+- [Frequently Asked Questions](https://docs.nautobot.com/projects/dev-example/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-dev-example/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/dev-example/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/dev-example/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_dev_example-1.0.0/nautobot_dev_example/__init__.py

@@ -0,0 +1,27 @@
+"""App declaration for nautobot_dev_example."""
+
+# Metadata is inherited from Nautobot. If not including Nautobot in the environment, this should be added
+from importlib import metadata
+
+from nautobot.apps import NautobotAppConfig
+
+__version__ = metadata.version(__name__)
+
+
+class NautobotDevExampleConfig(NautobotAppConfig):
+    """App configuration for the nautobot_dev_example app."""
+
+    name = "nautobot_dev_example"
+    verbose_name = "Nautobot Dev Example App"
+    version = __version__
+    author = "Network to Code, LLC"
+    description = "Nautobot App to demonstrate how to create a Nautobot App.."
+    base_url = "dev-example"
+    required_settings = []
+    min_version = "2.0.0"
+    max_version = "2.9999"
+    default_settings = {}
+    caching_config = {}
+
+
+config = NautobotDevExampleConfig  # pylint:disable=invalid-name

nautobot_dev_example-1.0.0/nautobot_dev_example/api/__init__.py

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

nautobot_dev_example-1.0.0/nautobot_dev_example/api/serializers.py

@@ -0,0 +1,18 @@
+"""API serializers for nautobot_dev_example."""
+
+from nautobot.apps.api import NautobotModelSerializer, TaggedModelSerializerMixin
+
+from nautobot_dev_example import models
+
+
+class DevExampleSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):  # pylint: disable=too-many-ancestors
+    """DevExample Serializer."""
+
+    class Meta:
+        """Meta attributes."""
+
+        model = models.DevExample
+        fields = "__all__"
+
+        # Option for disabling write for certain fields:
+        # read_only_fields = []

nautobot_dev_example-1.0.0/nautobot_dev_example/api/urls.py

@@ -0,0 +1,11 @@
+"""Django API urlpatterns declaration for nautobot_dev_example app."""
+
+from nautobot.apps.api import OrderedDefaultRouter
+
+from nautobot_dev_example.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("devexample", views.DevExampleViewSet)
+
+urlpatterns = router.urls

nautobot_dev_example-1.0.0/nautobot_dev_example/api/views.py

@@ -0,0 +1,17 @@
+"""API views for nautobot_dev_example."""
+
+from nautobot.apps.api import NautobotModelViewSet
+
+from nautobot_dev_example import filters, models
+from nautobot_dev_example.api import serializers
+
+
+class DevExampleViewSet(NautobotModelViewSet):  # pylint: disable=too-many-ancestors
+    """DevExample viewset."""
+
+    queryset = models.DevExample.objects.all()
+    serializer_class = serializers.DevExampleSerializer
+    filterset_class = filters.DevExampleFilterSet
+
+    # Option for modifying the default HTTP methods:
+    # http_method_names = ["get", "post", "put", "patch", "delete", "head", "options", "trace"]

nautobot_dev_example-1.0.0/nautobot_dev_example/app-config-schema.json

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

nautobot_dev_example-1.0.0/nautobot_dev_example/filters.py

@@ -0,0 +1,17 @@
+"""Filtering for nautobot_dev_example."""
+
+from nautobot.apps.filters import NameSearchFilterSet, NautobotFilterSet
+
+from nautobot_dev_example import models
+
+
+class DevExampleFilterSet(NautobotFilterSet, NameSearchFilterSet):  # pylint: disable=too-many-ancestors
+    """Filter for DevExample."""
+
+    class Meta:
+        """Meta attributes for filter."""
+
+        model = models.DevExample
+
+        # add any fields from the model that you would like to filter your searches by using those
+        fields = ["id", "name", "description"]

nautobot_dev_example-1.0.0/nautobot_dev_example/forms.py

@@ -0,0 +1,47 @@
+"""Forms for nautobot_dev_example."""
+
+from django import forms
+from nautobot.apps.forms import NautobotBulkEditForm, NautobotFilterForm, NautobotModelForm, TagsBulkEditFormMixin
+
+from nautobot_dev_example import models
+
+
+class DevExampleForm(NautobotModelForm):  # pylint: disable=too-many-ancestors
+    """DevExample creation/edit form."""
+
+    class Meta:
+        """Meta attributes."""
+
+        model = models.DevExample
+        fields = [
+            "name",
+            "description",
+        ]
+
+
+class DevExampleBulkEditForm(TagsBulkEditFormMixin, NautobotBulkEditForm):  # pylint: disable=too-many-ancestors
+    """DevExample bulk edit form."""
+
+    pk = forms.ModelMultipleChoiceField(queryset=models.DevExample.objects.all(), widget=forms.MultipleHiddenInput)
+    description = forms.CharField(required=False)
+
+    class Meta:
+        """Meta attributes."""
+
+        nullable_fields = [
+            "description",
+        ]
+
+
+class DevExampleFilterForm(NautobotFilterForm):
+    """Filter form to filter searches."""
+
+    model = models.DevExample
+    field_order = ["q", "name"]
+
+    q = forms.CharField(
+        required=False,
+        label="Search",
+        help_text="Search within Name or Slug.",
+    )
+    name = forms.CharField(required=False, label="Name")

nautobot_dev_example-1.0.0/nautobot_dev_example/migrations/0001_initial.py

@@ -0,0 +1,47 @@
+# Generated by Django 3.2.21 on 2024-02-16 08:32
+
+import uuid
+
+import django.core.serializers.json
+import nautobot.core.models.fields
+import nautobot.extras.models.mixins
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    initial = True
+
+    dependencies = [
+        ("extras", "0098_rename_data_jobresult_result"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="DevExample",
+            fields=[
+                (
+                    "id",
+                    models.UUIDField(
+                        default=uuid.uuid4, editable=False, primary_key=True, serialize=False, unique=True
+                    ),
+                ),
+                ("created", models.DateTimeField(auto_now_add=True, null=True)),
+                ("last_updated", models.DateTimeField(auto_now=True, null=True)),
+                (
+                    "_custom_field_data",
+                    models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder),
+                ),
+                ("name", models.CharField(max_length=100, unique=True)),
+                ("description", models.CharField(blank=True, max_length=200)),
+                ("tags", nautobot.core.models.fields.TagsField(through="extras.TaggedItem", to="extras.Tag")),
+            ],
+            options={
+                "ordering": ["name"],
+            },
+            bases=(
+                models.Model,
+                nautobot.extras.models.mixins.DynamicGroupMixin,
+                nautobot.extras.models.mixins.NotesMixin,
+            ),
+        ),
+    ]

nautobot_dev_example-1.0.0/nautobot_dev_example/models.py

@@ -0,0 +1,38 @@
+"""Models for Nautobot Dev Example App."""
+
+# Django imports
+from django.db import models
+
+# Nautobot imports
+from nautobot.apps.models import PrimaryModel
+
+# from nautobot.extras.utils import extras_features
+# If you want to use the extras_features decorator please reference the following documentation
+# https://docs.nautobot.com/projects/core/en/latest/plugins/development/#using-the-extras_features-decorator-for-graphql
+# Then based on your reading you may decide to put the following decorator before the declaration of your class
+# @extras_features("custom_fields", "custom_validators", "relationships", "graphql")
+
+
+# If you want to choose a specific model to overload in your class declaration, please reference the following documentation:
+# how to chose a database model: https://docs.nautobot.com/projects/core/en/stable/plugins/development/#database-models
+class DevExample(PrimaryModel):  # pylint: disable=too-many-ancestors
+    """Base model for Nautobot Dev Example App app."""
+
+    name = models.CharField(max_length=100, unique=True)
+    description = models.CharField(max_length=200, blank=True)
+    # additional model fields
+
+    class Meta:
+        """Meta class."""
+
+        ordering = ["name"]
+
+        # Option for fixing capitalization (i.e. "Snmp" vs "SNMP")
+        # verbose_name = "Nautobot Dev Example App"
+
+        # Option for fixing plural name (i.e. "Chicken Tenders" vs "Chicken Tendies")
+        # verbose_name_plural = "Nautobot Dev Example Apps"
+
+    def __str__(self):
+        """Stringify instance."""
+        return self.name

nautobot_dev_example-1.0.0/nautobot_dev_example/navigation.py

@@ -0,0 +1,24 @@
+"""Menu items."""
+
+from nautobot.apps.ui import NavMenuAddButton, NavMenuGroup, NavMenuItem, NavMenuTab
+
+items = (
+    NavMenuItem(
+        link="plugins:nautobot_dev_example:devexample_list",
+        name="Nautobot Dev Example App",
+        permissions=["nautobot_dev_example.view_devexample"],
+        buttons=(
+            NavMenuAddButton(
+                link="plugins:nautobot_dev_example:devexample_add",
+                permissions=["nautobot_dev_example.add_devexample"],
+            ),
+        ),
+    ),
+)
+
+menu_items = (
+    NavMenuTab(
+        name="Apps",
+        groups=(NavMenuGroup(name="Nautobot Dev Example App", items=tuple(items)),),
+    ),
+)