Merge pull request #62 from nautobot/u/whitej6-renaming

Renaming work

.cookiecutter.json

@@ -4,11 +4,11 @@
         "full_name": "Network to Code, LLC",
         "email": "info@networktocode.com",
         "github_org": "nautobot",
-        "plugin_name": "nautobot_floor_plan",
+        "app_name": "nautobot_floor_plan",
         "verbose_name": "Nautobot Floor Plan",
-        "plugin_slug": "nautobot-floor-plan",
-        "project_slug": "nautobot-plugin-floor-plan",
-        "repo_url": "https://github.com/nautobot/nautobot-plugin-floor-plan",
+        "app_slug": "nautobot-floor-plan",
+        "project_slug": "nautobot-app-floor-plan",
+        "repo_url": "https://github.com/nautobot/nautobot-app-floor-plan",
         "base_url": "floor-plan",
         "min_nautobot_version": "2.0.0",
         "max_nautobot_version": "2.9999",
@@ -32,4 +32,4 @@
             "baked_commit_ref": "649b2933f7e719c03e16ac9d694db63e994f4409"
         }
     }
-}
+}

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -31,5 +31,5 @@
 - [ ] Attached Screenshots, Payload Example
 - [ ] Unit, Integration Tests
 - [ ] Documentation Updates (when adding/changing features)
-- [ ] Example Plugin Updates (when adding/changing features)
+- [ ] Example App Updates (when adding/changing features)
 - [ ] Outline Remaining Work, Constraints from Design

.github/workflows/ci.yml

@@ -13,7 +13,7 @@ on: # yamllint disable-line rule:truthy rule:comments
   pull_request: ~
 
 env:
-  PLUGIN_NAME: "nautobot-plugin-floor-plan"
+  APP_NAME: "nautobot-app-floor-plan"
 
 jobs:
   black:
@@ -114,7 +114,7 @@ jobs:
           context: "./"
           push: false
           load: true
-          tags: "${{ env.PLUGIN_NAME }}/nautobot:${{ matrix.nautobot-version }}-py${{ matrix.python-version }}"
+          tags: "${{ env.APP_NAME }}/nautobot:${{ matrix.nautobot-version }}-py${{ matrix.python-version }}"
           file: "./development/Dockerfile"
           cache-from: "type=gha,scope=${{ matrix.nautobot-version }}-py${{ matrix.python-version }}"
           cache-to: "type=gha,scope=${{ matrix.nautobot-version }}-py${{ matrix.python-version }}"
@@ -157,7 +157,7 @@ jobs:
           context: "./"
           push: false
           load: true
-          tags: "${{ env.PLUGIN_NAME }}/nautobot:${{ matrix.nautobot-version }}-py${{ matrix.python-version }}"
+          tags: "${{ env.APP_NAME }}/nautobot:${{ matrix.nautobot-version }}-py${{ matrix.python-version }}"
           file: "./development/Dockerfile"
           cache-from: "type=gha,scope=${{ matrix.nautobot-version }}-py${{ matrix.python-version }}"
           cache-to: "type=gha,scope=${{ matrix.nautobot-version }}-py${{ matrix.python-version }}"
@@ -204,7 +204,7 @@ jobs:
           context: "./"
           push: false
           load: true
-          tags: "${{ env.PLUGIN_NAME }}/nautobot:${{ matrix.nautobot-version }}-py${{ matrix.python-version }}"
+          tags: "${{ env.APP_NAME }}/nautobot:${{ matrix.nautobot-version }}-py${{ matrix.python-version }}"
           file: "./development/Dockerfile"
           cache-from: "type=gha,scope=${{ matrix.nautobot-version }}-py${{ matrix.python-version }}"
           cache-to: "type=gha,scope=${{ matrix.nautobot-version }}-py${{ matrix.python-version }}"

.github/workflows/upstream_testing.yml

@@ -10,4 +10,4 @@ jobs:
     uses: "nautobot/nautobot/.github/workflows/plugin_upstream_testing_base.yml@develop"
     with:  # Below could potentially be collapsed into a single argument if a concrete relationship between both is enforced
       invoke_context_name: "NAUTOBOT_FLOOR_PLAN"
-      plugin_name: "nautobot-plugin-floor-plan"
+      plugin_name: "nautobot-app-floor-plan"

README.md

@@ -1,9 +1,9 @@
 # Nautobot Floor Plan
 
 <p align="center">
-  <img src="https://raw.githubusercontent.com/nautobot/nautobot-plugin-floor-plan/develop/docs/images/icon-nautobot-floor-plan.png" class="logo" height="200px">
+  <img src="https://raw.githubusercontent.com/nautobot/nautobot-app-floor-plan/develop/docs/images/icon-nautobot-floor-plan.png" class="logo" height="200px">
   <br>
-  <a href="https://github.com/nautobot/nautobot-plugin-floor-plan/actions"><img src="https://github.com/nautobot/nautobot-plugin-floor-plan/actions/workflows/ci.yml/badge.svg?branch=main"></a>
+  <a href="https://github.com/nautobot/nautobot-app-floor-plan/actions"><img src="https://github.com/nautobot/nautobot-app-floor-plan/actions/workflows/ci.yml/badge.svg?branch=main"></a>
   <a href="https://docs.nautobot.com/projects/floor-plan/en/latest"><img src="https://readthedocs.org/projects/nautobot-plugin-floor-plan/badge/"></a>
   <a href="https://pypi.org/project/nautobot-floor-plan/"><img src="https://img.shields.io/pypi/v/nautobot-floor-plan"></a>
   <a href="https://pypi.org/project/nautobot-floor-plan/"><img src="https://img.shields.io/pypi/dm/nautobot-floor-plan"></a>
@@ -17,13 +17,13 @@ This App aids in data center management by providing the ability to create a gri
 
 ### Screenshots
 
-![A sample floor plan](https://raw.githubusercontent.com/nautobot/nautobot-plugin-floor-plan/develop/docs/images/floor-plan-populated.png)
+![A sample floor plan](https://raw.githubusercontent.com/nautobot/nautobot-app-floor-plan/develop/docs/images/floor-plan-populated.png)
 
-![Button to add a new floor plan](https://raw.githubusercontent.com/nautobot/nautobot-plugin-floor-plan/develop/docs/images/add-floor-plan-button.png)
+![Button to add a new floor plan](https://raw.githubusercontent.com/nautobot/nautobot-app-floor-plan/develop/docs/images/add-floor-plan-button.png)
 
-![Form to define a new floor plan](https://raw.githubusercontent.com/nautobot/nautobot-plugin-floor-plan/develop/docs/images/add-floor-plan-form.png)
+![Form to define a new floor plan](https://raw.githubusercontent.com/nautobot/nautobot-app-floor-plan/develop/docs/images/add-floor-plan-form.png)
 
-![A new blank floor plan](https://raw.githubusercontent.com/nautobot/nautobot-plugin-floor-plan/develop/docs/images/floor-plan-empty.png)
+![A new blank floor plan](https://raw.githubusercontent.com/nautobot/nautobot-app-floor-plan/develop/docs/images/floor-plan-empty.png)
 
 More screenshots can be found in the [Using the App](https://docs.nautobot.com/projects/floor-plan/en/latest/user/app_use_cases/) page in the documentation.
 
@@ -39,7 +39,7 @@ Full documentation for this App can be found over on the [Nautobot Docs](https:/
 
 ### Contributing to the Documentation
 
-You can find all the Markdown source for the App documentation under the [`docs`](https://github.com/nautobot/nautobot-plugin-floor-plan/tree/develop/docs) folder in this repository. For simple edits, a Markdown capable editor is sufficient: clone the repository and edit away.
+You can find all the Markdown source for the App documentation under the [`docs`](https://github.com/nautobot/nautobot-app-floor-plan/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/floor-plan/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.
 

docs/admin/install.md

@@ -4,7 +4,7 @@ Here you will find detailed instructions on how to **install** and **configure**
 
 ## Prerequisites
 
-- The plugin is compatible with Nautobot 2.0.0 and higher.
+- The app is compatible with Nautobot 2.0.0 and higher.
 - Databases supported: PostgreSQL, MySQL
 
 !!! note
@@ -13,9 +13,9 @@ Here you will find detailed instructions on how to **install** and **configure**
 ## Install Guide
 
 !!! note
-    Plugins can be installed manually or using Python's `pip`. See the [Nautobot documentation](https://nautobot.readthedocs.io/en/latest/plugins/#install-the-package) for more details. The pip package name for this plugin is [`nautobot-floor-plan`](https://pypi.org/project/nautobot-floor-plan/).
+    Apps can be installed manually or using Python's `pip`. See the [Nautobot documentation](https://nautobot.readthedocs.io/en/latest/plugins/#install-the-package) for more details. The pip package name for this app is [`nautobot-floor-plan`](https://pypi.org/project/nautobot-floor-plan/).
 
-The plugin is available as a Python package via PyPI and can be installed with `pip`:
+The app is available as a Python package via PyPI and can be installed with `pip`:
 
 ```shell
 pip install nautobot-floor-plan
@@ -27,7 +27,7 @@ To ensure Nautobot Floor Plan is automatically re-installed during future upgrad
 echo nautobot-floor-plan >> local_requirements.txt
 ```
 
-Once installed, the plugin needs to be enabled in your Nautobot configuration. The following block of code below shows the additional configuration required to be added to your `nautobot_config.py` file:
+Once installed, the app needs to be enabled in your Nautobot configuration. The following block of code below shows the additional configuration required to be added to your `nautobot_config.py` file:
 
 - Append `"nautobot_floor_plan"` to the `PLUGINS` list.
 

docs/admin/uninstall.md

@@ -4,10 +4,10 @@ Here you will find any steps necessary to cleanly remove the App from your Nauto
 
 ## Database Cleanup
 
-Prior to removing the plugin from the `nautobot_config.py`, run the following command to roll back any migration specific to this plugin.
+Prior to removing the app from the `nautobot_config.py`, run the following command to roll back any migration specific to this app.
 
 ```shell
-nautobot-server migrate nautobot_plugin_floor_plan zero
+nautobot-server migrate nautobot_floor_plan zero
 ```
 
 !!! warning "Developer Note - Remove Me!"

docs/admin/upgrade.md

@@ -4,4 +4,4 @@ Here you will find any steps necessary to upgrade the App in your Nautobot envir
 
 ## Upgrade Guide
 
-When a new release comes out it may be necessary to run a migration of the database to account for any changes in the data models used by this plugin. Execute the command `nautobot-server post-upgrade` within the runtime environment of your Nautobot installation after updating the `nautobot-floor-plan` package via `pip`.
+When a new release comes out it may be necessary to run a migration of the database to account for any changes in the data models used by this app. Execute the command `nautobot-server post-upgrade` within the runtime environment of your Nautobot installation after updating the `nautobot-floor-plan` package via `pip`.

docs/dev/contributing.md

@@ -6,7 +6,7 @@ The project is following Network to Code software development guidelines and is
 
 - Python linting and formatting: `black`, `pylint`, `bandit`, `flake8`, and `pydocstyle`.
 - YAML linting is done with `yamllint`.
-- Django unit test to ensure the plugin is working properly.
+- Django unit test to ensure the app is working properly.
 
 Documentation is built using [mkdocs](https://www.mkdocs.org/). The [Docker based development environment](dev_environment.md#docker-development-environment) automatically starts a container hosting a live version of the documentation website on [http://localhost:8001](http://localhost:8001) that auto-refreshes when you make any changes to your local files.
 

docs/dev/dev_environment.md

@@ -127,8 +127,8 @@ Each command can be executed with `invoke <command>`. All commands support the a
   flake8           Run flake8 to check that Python files adhere to its style standards.
   pydocstyle       Run pydocstyle to validate docstring formatting adheres to NTC defined standards.
   pylint           Run pylint code analysis.
-  tests            Run all tests for this plugin.
-  unittest         Run Django unit tests for the plugin.
+  tests            Run all tests for this app.
+  unittest         Run Django unit tests for the app.
 ```
 
 ## Project Overview
@@ -290,9 +290,9 @@ This will safely shut down all of your running Docker containers for this projec
 
 Your environment should now be fully setup, all necessary Docker containers are created and running, and you're logged into Nautobot in your web browser. Now what?
 
-Now you can start developing your plugin in the project folder!
+Now you can start developing your app in the project folder!
 
-The magic here is the root directory is mounted inside your Docker containers when built and ran, so **any** changes made to the files in here are directly updated to the Nautobot plugin code running in Docker. This means that as you modify the code in your plugin folder, the changes will be instantly updated in Nautobot.
+The magic here is the root directory is mounted inside your Docker containers when built and ran, so **any** changes made to the files in here are directly updated to the Nautobot app code running in Docker. This means that as you modify the code in your app folder, the changes will be instantly updated in Nautobot.
 
 !!! warning
     There are a few exceptions to this, as outlined in the section [To Rebuild or Not To Rebuild](#to-rebuild-or-not-to-rebuild).
@@ -316,7 +316,7 @@ When trying to debug an issue, one helpful thing you can look at are the logs wi
 !!! info
     Want to limit the log output even further? Use the `--tail <#>` command line argument in conjunction with `-f`.
 
-So for example, our plugin is named `nautobot-floor-plan`, the command would most likely be `docker logs nautobot_floor_plan_nautobot_1 -f`. You can find the name of all running containers via `docker ps`.
+So for example, our app is named `nautobot-floor-plan`, the command would most likely be `docker logs nautobot_floor_plan_nautobot_1 -f`. You can find the name of all running containers via `docker ps`.
 
 If you want to view the logs specific to the worker container, simply use the name of that container instead.
 
@@ -342,7 +342,7 @@ Once completed, the new/updated environment variables should now be live.
 
 ### Installing Additional Python Packages
 
-If you want your plugin to leverage another available Nautobot plugin or another Python package, you can easily add them into your Docker environment.
+If you want your app to leverage another available Nautobot app or another Python package, you can easily add them into your Docker environment.
 
 ```bash
 ➜ poetry shell
@@ -357,26 +357,26 @@ Once the dependencies are resolved, stop the existing containers, rebuild the Do
 ➜ invoke start
 ```
 
-### Installing Additional Nautobot Plugins
+### Installing Additional Nautobot Apps
 
-Let's say for example you want the new plugin you're creating to integrate into Slack. To do this, you will want to integrate into the existing Nautobot ChatOps Plugin.
+Let's say for example you want the new app you're creating to integrate into Slack. To do this, you will want to integrate into the existing Nautobot ChatOps App.
 
 ```bash
 ➜ poetry shell
 ➜ poetry add nautobot-chatops
 ```
 
-Once you activate the virtual environment via Poetry, you then tell Poetry to install the new plugin.
+Once you activate the virtual environment via Poetry, you then tell Poetry to install the new app.
 
-Before you continue, you'll need to update the file `development/nautobot_config.py` accordingly with the name of the new plugin under `PLUGINS` and any relevant settings as necessary for the plugin under `PLUGINS_CONFIG`. Since you're modifying the underlying OS (not just Django files), you need to rebuild the image. This is a similar process to updating environment variables, which was explained earlier.
+Before you continue, you'll need to update the file `development/nautobot_config.py` accordingly with the name of the new app under `PLUGINS` and any relevant settings as necessary for the app under `PLUGINS_CONFIG`. Since you're modifying the underlying OS (not just Django files), you need to rebuild the image. This is a similar process to updating environment variables, which was explained earlier.
 
 ```bash
 ➜ invoke stop
 ➜ invoke build
 ➜ invoke start
 ```
 
-Once the containers are up and running, you should now see the new plugin installed in your Nautobot instance.
+Once the containers are up and running, you should now see the new app installed in your Nautobot instance.
 
 !!! note
     You can even launch an `ngrok` service locally on your laptop, pointing to port 8080 (such as for chatops development), and it will point traffic directly to your Docker images.

docs/dev/extending.md

@@ -1,3 +1,3 @@
 # Extending the App
 
-Contributions to augment the capabilities of this App are more than welcome. A backlog of planned and/or requested features and fixes is [available on GitHub](https://github.com/nautobot/nautobot-plugin-floor-plan/issues). If you find a new bug, or have a new feature in mind, we recommend opening an issue first for discussion and visibility before you invest significant time into developing new code.
+Contributions to augment the capabilities of this App are more than welcome. A backlog of planned and/or requested features and fixes is [available on GitHub](https://github.com/nautobot/nautobot-app-floor-plan/issues). If you find a new bug, or have a new feature in mind, we recommend opening an issue first for discussion and visibility before you invest significant time into developing new code.

mkdocs.yml

@@ -1,10 +1,10 @@
 ---
 dev_addr: "127.0.0.1:8001"
-edit_uri: "edit/main/nautobot-plugin-floor-plan/docs"
+edit_uri: "edit/main/nautobot-app-floor-plan/docs"
 site_dir: "nautobot_floor_plan/static/nautobot_floor_plan/docs"
 site_name: "Nautobot Floor Plan Documentation"
 site_url: "https://docs.nautobot.com/projects/floor-plan/en/latest/"
-repo_url: "https://github.com/nautobot/nautobot-plugin-floor-plan"
+repo_url: "https://github.com/nautobot/nautobot-app-floor-plan"
 copyright: "Copyright © The Authors"
 theme:
   name: "material"

nautobot_floor_plan/__init__.py

@@ -1,4 +1,4 @@
-"""Plugin declaration for nautobot_floor_plan."""
+"""App declaration for nautobot_floor_plan."""
 # Metadata is inherited from Nautobot. If not including Nautobot in the environment, this should be added
 from importlib import metadata
 
@@ -8,7 +8,7 @@
 
 
 class FloorPlanConfig(NautobotAppConfig):
-    """Plugin configuration for the nautobot_floor_plan plugin."""
+    """App configuration for the nautobot_floor_plan app."""
 
     name = "nautobot_floor_plan"
     verbose_name = "Floor Plans"

nautobot_floor_plan/api/__init__.py

@@ -1 +1 @@
-"""REST API module for nautobot_floor_plan plugin."""
+"""REST API module for nautobot_floor_plan app."""

nautobot_floor_plan/api/urls.py

@@ -1,4 +1,4 @@
-"""Django API urlpatterns declaration for nautobot_floor_plan plugin."""
+"""Django API urlpatterns declaration for nautobot_floor_plan app."""
 
 from nautobot.apps.api import OrderedDefaultRouter
 

nautobot_floor_plan/template_content.py

@@ -6,7 +6,7 @@
 
 
 class LocationFloorPlanTab(PluginTemplateExtension):  # pylint: disable=abstract-method
-    """Plugin extensions for Location model detail view."""
+    """App extensions for Location model detail view."""
 
     model = "dcim.location"
 

nautobot_floor_plan/tests/__init__.py

@@ -1 +1 @@
-"""Unit tests for nautobot_floor_plan plugin."""
+"""Unit tests for nautobot_floor_plan app."""

nautobot_floor_plan/urls.py

@@ -1,4 +1,4 @@
-"""Django urlpatterns declaration for nautobot_floor_plan plugin."""
+"""Django urlpatterns declaration for nautobot_floor_plan app."""
 
 from django.urls import path
 

pyproject.toml

@@ -5,9 +5,9 @@ description = "Nautobot Floor Plan"
 authors = ["Network to Code, LLC <info@networktocode.com>"]
 license = "Apache-2.0"
 readme = "README.md"
-homepage = "https://github.com/nautobot/nautobot-plugin-floor-plan"
-repository = "https://github.com/nautobot/nautobot-plugin-floor-plan"
-keywords = ["nautobot", "nautobot-plugin"]
+homepage = "https://github.com/nautobot/nautobot-app-floor-plan"
+repository = "https://github.com/nautobot/nautobot-app-floor-plan"
+keywords = ["nautobot", "nautobot-plugin", "nautobot-app"]
 classifiers = [
     "Intended Audience :: Developers",
     "Development Status :: 5 - Production/Stable",

tasks.py

@@ -683,7 +683,7 @@ def unittest_coverage(context):
     }
 )
 def tests(context, failfast=False, keepdb=False, lint_only=False):
-    """Run all tests for this plugin."""
+    """Run all tests for this app."""
     # If we are not running locally, start the docker containers so we don't have to for each test
     if not is_truthy(context.nautobot_floor_plan.local):
         print("Starting Docker Containers...")