diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md index 3950227c..b1eba070 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ b/.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 diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index eeb536ab..b3160b08 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -13,7 +13,7 @@ on: # yamllint disable-line rule:truthy rule:comments pull_request: ~ env: - PLUGIN_NAME: "nautobot-plugin-chatops" + PLUGIN_NAME: "nautobot-app-chatops" jobs: black: diff --git a/.github/workflows/upstream_testing.yml b/.github/workflows/upstream_testing.yml index b23adc45..f8bc77b5 100644 --- a/.github/workflows/upstream_testing.yml +++ b/.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_CHATOPS" - plugin_name: "nautobot-plugin-chatops" + plugin_name: "nautobot-app-chatops" diff --git a/CHANGELOG.md b/CHANGELOG.md index 1331da75..cd6a4584 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,4 @@ -# Changelog - Nautobot Plugin ChatOps +# Changelog - Nautobot App ChatOps The changelog has been moved to the [project release notes](https://docs.nautobot.com/projects/chatops/en/latest/admin/release_notes/). diff --git a/README.md b/README.md index 36c0a150..5af700d6 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ # Nautobot ChatOps

- +
- + @@ -25,9 +25,9 @@ - Cisco Meraki - Palo Alto Panorama - Write a command once and run it on every supported platform, including rich content formatting. -- Extensible - other Nautobot plugins can provide additional commands which will be dynamically discovered. +- Extensible - other Nautobot apps can provide additional commands which will be dynamically discovered. - Automatic generation of basic help menus (accessed via `help`, `/command help`, or `/command sub-command help`). -- Metrics of command usage via the `nautobot_capacity_metrics` plugin. +- Metrics of command usage via the `nautobot_capacity_metrics` app. ## Documentation @@ -63,7 +63,7 @@ Sign up [here](https://slack.networktocode.com/) ## Acknowledgements -This project includes code originally written in separate plugins, which have been merged into this project: +This project includes code originally written in separate apps, which have been merged into this project: - [nautobot-plugin-chatops-aci](https://github.com/nautobot/nautobot-plugin-chatops-aci): Thanks diff --git a/development/towncrier_template.j2 b/development/towncrier_template.j2 index b4d289b2..618f0214 100644 --- a/development/towncrier_template.j2 +++ b/development/towncrier_template.j2 @@ -1,5 +1,5 @@ {% if render_title %} -## [v{{ versiondata.version }} ({{ versiondata.date }})](https://github.com/nautobot/nautobot-plugin-chatops/releases/tag/v{{ versiondata.version}}) +## [v{{ versiondata.version }} ({{ versiondata.date }})](https://github.com/nautobot/nautobot-app-chatops/releases/tag/v{{ versiondata.version}}) {% endif %} {% for section, _ in sections.items() %} diff --git a/docs/admin/compatibility_matrix.md b/docs/admin/compatibility_matrix.md index bdea453b..c799cf60 100644 --- a/docs/admin/compatibility_matrix.md +++ b/docs/admin/compatibility_matrix.md @@ -4,7 +4,7 @@ Changes to the support of upstream Nautobot releases will be announced 1 minor o The **deprecation policy** will be announced within the [release notes](release_notes/index.md), and updated in the table below. There will be a `stable-.` branch that will be minimally maintained. Any security enhancements or major bugs in that branch will be supported for a limited time. -While that last supported version will not be strictly enforced via the `max_version` setting, any issues with an updated Nautobot supported version in a minor release will require raising a bug and fixing it in Nautobot core, with no fixes expected in this plugin. This allows the Chatops plugin the ability to quickly take advantage of the latest features in Nautobot. +While that last supported version will not be strictly enforced via the `max_version` setting, any issues with an updated Nautobot supported version in a minor release will require raising a bug and fixing it in Nautobot core, with no fixes expected in this app. This allows the Chatops app the ability to quickly take advantage of the latest features in Nautobot. | Chatops Version | Nautobot First Support Version | Nautobot Last Support Version | | --------------- | ------------------------------ | ----------------------------- | diff --git a/docs/admin/install/grafana_setup.md b/docs/admin/install/grafana_setup.md index 87db5dcf..d6ea815c 100644 --- a/docs/admin/install/grafana_setup.md +++ b/docs/admin/install/grafana_setup.md @@ -13,7 +13,7 @@ Before configuring the integration, please ensure the following: - `nautobot-chatops` App is set up with at least one [enabled chat platform](./index.md#chat-platforms-configuration) and [tested](./index.md#test-your-chatbot). - [Grafana](https://grafana.com/docs/grafana/latest/installation/) application installed and configured with dashboards and panels. - [Grafana Image Rendering Service](https://grafana.com/docs/grafana/latest/administration/image_rendering/) installed. -- [Grafana Image Rending Plugin for Grafana](https://grafana.com/grafana/plugins/grafana-image-renderer/) installed in your Grafana application. +- [Grafana Image Rending App for Grafana](https://grafana.com/grafana/plugins/grafana-image-renderer/) installed in your Grafana application. ## Command Setup diff --git a/docs/admin/install/ipfabric_setup.md b/docs/admin/install/ipfabric_setup.md index 66587436..96b1985a 100644 --- a/docs/admin/install/ipfabric_setup.md +++ b/docs/admin/install/ipfabric_setup.md @@ -14,7 +14,7 @@ Before configuring the integration, please ensure the following: ## Version Matrix -Here is a compatibility matrix and the minimum versions required to run this plugin: +Here is a compatibility matrix and the minimum versions required to run this app: | IP Fabric | Python | Nautobot | chatops | chatops-ipfabric | [python-ipfabric](https://github.com/community-fabric/python-ipfabric) | [python-ipfabric-diagrams](https://github.com/community-fabric/python-ipfabric-diagrams) | |-----------|--------|----------|---------|------------------|------------------------------------------------------------------------|------------------------------------------------------------------------------------------| @@ -96,6 +96,6 @@ PLUGINS_CONFIG = { ``` !!! warning - Configuration keys for IPFabric integration are now lowercased, compared to the old plugin. + Configuration keys for IPFabric integration are now lowercased, compared to the old app. Environment variables for this integration are the same for both, old and new configuration. diff --git a/docs/admin/install/mattermost_setup.md b/docs/admin/install/mattermost_setup.md index d437f6fb..cc0c5f4a 100644 --- a/docs/admin/install/mattermost_setup.md +++ b/docs/admin/install/mattermost_setup.md @@ -39,4 +39,4 @@ ## General Chat Setup Instructions -See [admin_install](index.md) instructions here for general plugin setup instructions. +See [admin_install](index.md) instructions here for general app setup instructions. diff --git a/docs/admin/install/microsoft_teams_setup.md b/docs/admin/install/microsoft_teams_setup.md index beb16952..20baaf56 100644 --- a/docs/admin/install/microsoft_teams_setup.md +++ b/docs/admin/install/microsoft_teams_setup.md @@ -25,7 +25,7 @@ ## MS Teams Developer Portal 1. To deploy the bot to your team, log in to the [Microsoft Developer Portal](https://dev.teams.microsoft.com/) and select “Apps” from the left-hand menu. -2. Select "Import app" and upload the Nautobot ChatOps_ms_teams.zip file. It can be found from this directory or downloaded from GitHub [here](https://github.com/nautobot/nautobot-plugin-chatops/blob/develop/Nautobot_ms_teams.zip). **NOTE:** If you get an error stating “App package has errors”, you can ignore this and click on “Import” to complete the import. +2. Select "Import app" and upload the Nautobot ChatOps_ms_teams.zip file. It can be found from this directory or downloaded from GitHub [here](https://github.com/nautobot/nautobot-app-chatops/blob/develop/Nautobot_ms_teams.zip). **NOTE:** If you get an error stating “App package has errors”, you can ignore this and click on “Import” to complete the import. 3. Under section “Configure”, select “Basic Information”. Scroll to the bottom. Under “Application (client) ID, type in the value that you took note of above in Azure step 10. 4. Under section “Configure”, select “App features”. Select the triple dots (...) next to the “Bot” tile and select “Edit”. 5. On the Bot Edit page, under section “Identify your bot,” select “Enter a bot ID” and type in the same App ID value used above in step 4. Click Save. @@ -53,4 +53,4 @@ Reference the [Setting Up Nautobot ChatOps With MSTeams Fall 2022](https://blog. ## General Chat Setup Instructions -See [admin_install](index.md) instructions here for general plugin setup instructions. +See [admin_install](index.md) instructions here for general app setup instructions. diff --git a/docs/admin/install/slack_setup.md b/docs/admin/install/slack_setup.md index 95c62921..34a54bad 100644 --- a/docs/admin/install/slack_setup.md +++ b/docs/admin/install/slack_setup.md @@ -18,7 +18,7 @@ For now, take a mental note that in this section where we are configuring the Sl Example config snippet from `nautobot_config.py` for configuring ChatOps with Slack: ```python -# Enable installed plugins. Add the name of each plugin to the list. +# Enable installed apps. Add the name of each app to the list. PLUGINS = ["nautobot_chatops"] PLUGINS_CONFIG = { @@ -32,13 +32,13 @@ PLUGINS_CONFIG = { !!! info Optional: Logos rely on Slack being able to access the Static URL provided by Nautobot. If you are running - Slack in Socket Mode, Nautobot ChatOps Plugin will need you to specify where the static files are hosted. + Slack in Socket Mode, Nautobot ChatOps App will need you to specify where the static files are hosted. This is helpful for giving Slack access to only the server hosting Nautobot Static Files. To configure the static files host, use `slack_socket_static_host` ex. `slack_socket_static_host: 'https://example.com/static/'`. ## Connecting to Slack -The Nautobot ChatOps plugin supports two methods of communicating with Slack. +The Nautobot ChatOps app supports two methods of communicating with Slack. 1. Incoming Webhooks 2. Socket Mode @@ -48,7 +48,7 @@ The Nautobot ChatOps plugin supports two methods of communicating with Slack. ### Webhooks vs. Socket Mode -With incoming webhooks, whenever a user sends a message to the bot via the client application (phone or desktop app), (1) the connection is initiated from the client, and the message gets sent to Slack's cloud. The Slack servers then initiate a connection to the ChatOps plugin running on the Nautobot server (2). Since this is a new, incoming connection, it must be port forwarded and allowed through any firewalls in your network between the internet and your Nautobot server (3). Nautobot then replies to the existing connection to Slack, which in turn forwards the response to the client. +With incoming webhooks, whenever a user sends a message to the bot via the client application (phone or desktop app), (1) the connection is initiated from the client, and the message gets sent to Slack's cloud. The Slack servers then initiate a connection to the ChatOps app running on the Nautobot server (2). Since this is a new, incoming connection, it must be port forwarded and allowed through any firewalls in your network between the internet and your Nautobot server (3). Nautobot then replies to the existing connection to Slack, which in turn forwards the response to the client. ![Chatops Slack Webhooks Mode](../../images/chatops-slack-webhooks-mode.png) @@ -64,7 +64,7 @@ While there are sufficient ways of securing inbound API requests from the public 1. Log in to [https://api.slack.com/apps](https://api.slack.com/apps) and select "Create New App". Select "From an app manifest." 2. Select your preferred Slack workspace for your app. -3. In the window titled "Enter app manifest below," select the "YAML" formatting tab and copy/paste the contents of file [nautobot_slack_manifest.yml](https://github.com/nautobot/nautobot-plugin-chatops/blob/develop/setup_files/nautobot_slack_manifest.yml) from this repo. Update the below settings, then click Next. +3. In the window titled "Enter app manifest below," select the "YAML" formatting tab and copy/paste the contents of file [nautobot_slack_manifest.yml](https://github.com/nautobot/nautobot-app-chatops/blob/develop/setup_files/nautobot_slack_manifest.yml) from this repo. Update the below settings, then click Next. - On line 5, you can change the name of the Chatbot here. By default it is set to `Nautobot` - If using Socket mode: - On line 34, update `socket_mode_enabled` to `true` @@ -85,7 +85,7 @@ While there are sufficient ways of securing inbound API requests from the public 8. Under Settings --> Install App, copy the `Bot User OAuth Token` here. This will be needed later for setting `SLACK_API_TOKEN`. 9. Continue with below section "Post App-Creation Steps" -> **Optional:** You can configure the App Icon on the General --> Basic Information page. Under `App Icon`, select "Choose File." You can use the supplied icon [nautobot_chatops_icon.png](https://github.com/nautobot/nautobot-plugin-chatops/blob/develop/setup_files/nautobot_chatops_icon.png). +> **Optional:** You can configure the App Icon on the General --> Basic Information page. Under `App Icon`, select "Choose File." You can use the supplied icon [nautobot_chatops_icon.png](https://github.com/nautobot/nautobot-app-chatops/blob/develop/setup_files/nautobot_chatops_icon.png). ## Post App-Creation Steps @@ -149,7 +149,7 @@ They will be differentiated in the workspace using the `slack_slash_command_pref Here is an example `nautobot_config.py` for the first Nautobot chatbot implementation in the workspace. This chatbot will be called in the workspace using `/nautobot`. ```python -# Enable installed plugins. Add the name of each plugin to the list. +# Enable installed apps. Add the name of each app to the list. PLUGINS = ["nautobot_chatops"] PLUGINS_CONFIG = { @@ -166,7 +166,7 @@ This configuration explicitly configures the `slack_slash_command_prefix` key/va This chatbot will be called in the workspace using `/network2-nautobot`. ```python -# Enable installed plugins. Add the name of each plugin to the list. +# Enable installed apps. Add the name of each app to the list. PLUGINS = ["nautobot_chatops"] PLUGINS_CONFIG = { @@ -186,7 +186,7 @@ PLUGINS_CONFIG = { ## General Chat Setup Instructions -See [admin_install](index.md) instructions here for general plugin setup instructions. +See [admin_install](index.md) instructions here for general app setup instructions. ## Startup Slack Sockets (Socket Mode) @@ -277,7 +277,7 @@ While this method is still possible, we recommend using the App Manifest method > `/network2-nautobot` command would have a `slack_slash_command_prefix` of `/network2-` 4. On the "Basic Information" page for your app, under "App Credentials", find the "Signing Secret" and click "Show". - You will need to configure this value for the plugin as the `slack_signing_secret` value, such as through an + You will need to configure this value for the app as the `slack_signing_secret` value, such as through an `.env` file. If this value is not correctly configured, the bot will be unable to validate that inbound notifications it receives have been properly signed by the Slack server. 5. In the sidebar to the left, select "OAuth & Permissions". @@ -295,7 +295,7 @@ While this method is still possible, we recommend using the App Manifest method - `mpim:read` - At the top of this page, select "Install App to Workspace" and confirm it. - There should now be a "Bot User OAuth Access Token" displayed, typically a string starting with `xoxb-`. - You will need to configure this value for the plugin as the `slack_api_token` value, either directly or through an + You will need to configure this value for the app as the `slack_api_token` value, either directly or through an `.env` file. If this value is not properly configured, the bot will be unable to send content to the user. 6. Returning to the "Basic Information" page for your app, under "Display Information", you can specify the name, description, icon, and accent/background color for the app. You can use the `nautobot_logo.png` from this diff --git a/docs/admin/install/webex_setup.md b/docs/admin/install/webex_setup.md index 8d816ef3..3304269f 100644 --- a/docs/admin/install/webex_setup.md +++ b/docs/admin/install/webex_setup.md @@ -32,7 +32,7 @@ ## Deprecation Warning -As of Nautobot ChatOps Plugin v2.0.0, there are the following changes: +As of Nautobot ChatOps App v2.0.0, there are the following changes: - The deprecated URL API path `webex_teams` has been removed. Please use `webex` as a substitute. - The use and deprecation warnings for the obsolete `webex_teams` App configuration entries have been removed. These entries include: @@ -50,7 +50,7 @@ As of Nautobot ChatOps Plugin v2.0.0, there are the following changes: } ``` -As of Nautobot ChatOps Plugin v1.4.0, the PLUGIN_CONFIG settings for Webex has changed to align with the official renaming of `Webex Teams` to `Webex`: +As of Nautobot ChatOps App v1.4.0, the PLUGIN_CONFIG settings for Webex has changed to align with the official renaming of `Webex Teams` to `Webex`: - `enable_webex_teams` is deprecated. Use `enable_webex` instead. - `webex_teams_token` is deprecated. Use `webex_token` instead. @@ -60,4 +60,4 @@ Both settings will currently work, however support for `enable_webex_teams`, `we ## General Chat Setup Instructions -See [admin_install](index.md) instructions here for general plugin setup instructions. +See [admin_install](index.md) instructions here for general app setup instructions. diff --git a/docs/admin/release_notes/version_1.1.md b/docs/admin/release_notes/version_1.1.md index 4965d501..ba7b8b26 100644 --- a/docs/admin/release_notes/version_1.1.md +++ b/docs/admin/release_notes/version_1.1.md @@ -1,12 +1,12 @@ # v1.1 Release Notes -## [v1.1.0](https://github.com/nautobot/nautobot-plugin-chatops/releases/tag/v1.1.0) +## [v1.1.0](https://github.com/nautobot/nautobot-app-chatops/releases/tag/v1.1.0) ### What's New -- Slack handling of list items > 100 items, now including a `next` option in the drop down list to get more options [#10](https://github.com/nautobot/nautobot-plugin-chatops/pull/10) +- Slack handling of list items > 100 items, now including a `next` option in the drop down list to get more options [#10](https://github.com/nautobot/nautobot-app-chatops/pull/10) ### Bug Fixes -- Updated MS Teams Zip File [#29](https://github.com/nautobot/nautobot-plugin-chatops/pull/29) -- Fix connection filter ordering [#23](https://github.com/nautobot/nautobot-plugin-chatops/pull/23) +- Updated MS Teams Zip File [#29](https://github.com/nautobot/nautobot-app-chatops/pull/29) +- Fix connection filter ordering [#23](https://github.com/nautobot/nautobot-app-chatops/pull/23) diff --git a/docs/admin/release_notes/version_1.10.md b/docs/admin/release_notes/version_1.10.md index af7c313e..16037214 100644 --- a/docs/admin/release_notes/version_1.10.md +++ b/docs/admin/release_notes/version_1.10.md @@ -3,11 +3,11 @@ -## [v1.10.0](https://github.com/nautobot/nautobot-plugin-chatops/releases/tag/v1.10.0) +## [v1.10.0](https://github.com/nautobot/nautobot-app-chatops/releases/tag/v1.10.0) ### What's Changed * Drop official support for Nautobot <1.3.0 * Add support for Slack Socket Mode. -[**Full Changelog**](https://github.com/nautobot/nautobot-plugin-chatops/compare/v1.9.1...v1.10.0) +[**Full Changelog**](https://github.com/nautobot/nautobot-app-chatops/compare/v1.9.1...v1.10.0) diff --git a/docs/admin/release_notes/version_1.11.md b/docs/admin/release_notes/version_1.11.md index 1bd87485..33834515 100644 --- a/docs/admin/release_notes/version_1.11.md +++ b/docs/admin/release_notes/version_1.11.md @@ -2,21 +2,21 @@ # v1.11 Release Notes -## [v1.11.0 (2023-03-11)](https://github.com/nautobot/nautobot-plugin-chatops/releases/tag/v1.11.0) +## [v1.11.0 (2023-03-11)](https://github.com/nautobot/nautobot-app-chatops/releases/tag/v1.11.0) ### Added -- [#166](https://github.com/nautobot/nautobot-plugin-chatops/issues/166) - Add documentation for contributing WebSocket Platform support. -- [#171](https://github.com/nautobot/nautobot-plugin-chatops/issues/171) - Enable Upstream Testing with Nautobot. -- [#182](https://github.com/nautobot/nautobot-plugin-chatops/issues/182) - Add option to limit Help prompt based on user Access Grants. +- [#166](https://github.com/nautobot/nautobot-app-chatops/issues/166) - Add documentation for contributing WebSocket Platform support. +- [#171](https://github.com/nautobot/nautobot-app-chatops/issues/171) - Enable Upstream Testing with Nautobot. +- [#182](https://github.com/nautobot/nautobot-app-chatops/issues/182) - Add option to limit Help prompt based on user Access Grants. ### Changed -- [#94](https://github.com/nautobot/nautobot-plugin-chatops/issues/94) - Clarified the description of Access Grants for Webex Teams. -- [#147](https://github.com/nautobot/nautobot-plugin-chatops/issues/147) - Left Align Column headers for tables to match the rows. -- [#173](https://github.com/nautobot/nautobot-plugin-chatops/issues/173) - Update App description. -- [#174](https://github.com/nautobot/nautobot-plugin-chatops/issues/174) - Change list views to use generic/object_list.html template. +- [#94](https://github.com/nautobot/nautobot-app-chatops/issues/94) - Clarified the description of Access Grants for Webex Teams. +- [#147](https://github.com/nautobot/nautobot-app-chatops/issues/147) - Left Align Column headers for tables to match the rows. +- [#173](https://github.com/nautobot/nautobot-app-chatops/issues/173) - Update App description. +- [#174](https://github.com/nautobot/nautobot-app-chatops/issues/174) - Change list views to use generic/object_list.html template. ### Removed -- [#138](https://github.com/nautobot/nautobot-plugin-chatops/issues/138) - Remove WEBEX_TOKEN warning when Webex is disabled. +- [#138](https://github.com/nautobot/nautobot-app-chatops/issues/138) - Remove WEBEX_TOKEN warning when Webex is disabled. diff --git a/docs/admin/release_notes/version_1.2.md b/docs/admin/release_notes/version_1.2.md index 14344158..8049818c 100644 --- a/docs/admin/release_notes/version_1.2.md +++ b/docs/admin/release_notes/version_1.2.md @@ -1,10 +1,10 @@ # v1.2 Release Notes -## [v1.2.0](https://github.com/nautobot/nautobot-plugin-chatops/releases/tag/v1.2.0) +## [v1.2.0](https://github.com/nautobot/nautobot-app-chatops/releases/tag/v1.2.0) - Replaces Slack client (slack_client) with Slack SDK (https://pypi.org/project/slack-sdk/) - This update does not require any code changes to the bots that leverage Slack. This does require the update of system requirements on installation. ### Fixes -[#2](https://github.com/nautobot/nautobot-plugin-chatops/issues/2) - Cisco WebEx error on content too large +[#2](https://github.com/nautobot/nautobot-app-chatops/issues/2) - Cisco WebEx error on content too large diff --git a/docs/admin/release_notes/version_1.3.md b/docs/admin/release_notes/version_1.3.md index 3e428eb7..3c6f50dd 100644 --- a/docs/admin/release_notes/version_1.3.md +++ b/docs/admin/release_notes/version_1.3.md @@ -1,6 +1,6 @@ # v1.3 Release Notes -## [v1.3.0](https://github.com/nautobot/nautobot-plugin-chatops/releases/tag/v1.3.0) +## [v1.3.0](https://github.com/nautobot/nautobot-app-chatops/releases/tag/v1.3.0) Updates to pyjwt to address concerns with other dependencies in the Nautobot ecosystem. @@ -9,8 +9,8 @@ Updates to pyjwt to address concerns with other dependencies in the Nautobot eco Updates pyjwt from 1.7.1 minimum to 2.1 Adds cryptography as separate requirement -## [v1.3.1](https://github.com/nautobot/nautobot-plugin-chatops/releases/tag/v1.3.1) +## [v1.3.1](https://github.com/nautobot/nautobot-app-chatops/releases/tag/v1.3.1) ### Fixes -- [#54)](https://github.com/nautobot/nautobot-plugin-chatops/pull/54) Reverted pinning of cryptography +- [#54)](https://github.com/nautobot/nautobot-app-chatops/pull/54) Reverted pinning of cryptography diff --git a/docs/admin/release_notes/version_1.4.md b/docs/admin/release_notes/version_1.4.md index cdb23dc0..61f9334b 100644 --- a/docs/admin/release_notes/version_1.4.md +++ b/docs/admin/release_notes/version_1.4.md @@ -1,19 +1,19 @@ # v1.4 Release Notes -## [v1.4.0](https://github.com/nautobot/nautobot-plugin-chatops/releases/tag/v1.4.0) +## [v1.4.0](https://github.com/nautobot/nautobot-app-chatops/releases/tag/v1.4.0) Updates Nautobot ChatOps name for Webex Teams to Webex. As part of Cisco's renaming of Webex Teams to just Webex, the underlying configuration was updated. ### Fixes -[#68)](https://github.com/nautobot/nautobot-plugin-chatops/pull/68) Correct var names for Nautobot -[#61)](https://github.com/nautobot/nautobot-plugin-chatops/pull/61) Mattermost sending interactive Dialog +[#68)](https://github.com/nautobot/nautobot-app-chatops/pull/68) Correct var names for Nautobot +[#61)](https://github.com/nautobot/nautobot-app-chatops/pull/61) Mattermost sending interactive Dialog ### Updates -[#63)](https://github.com/nautobot/nautobot-plugin-chatops/pull/63) Add additional Breadcrumbs -[#24](https://github.com/nautobot/nautobot-plugin-chatops/issues/24) Rename Webex Teams to Webex +[#63)](https://github.com/nautobot/nautobot-app-chatops/pull/63) Add additional Breadcrumbs +[#24](https://github.com/nautobot/nautobot-app-chatops/issues/24) Rename Webex Teams to Webex -## [v1.4.1](https://github.com/nautobot/nautobot-plugin-chatops/releases/tag/v1.4.1) +## [v1.4.1](https://github.com/nautobot/nautobot-app-chatops/releases/tag/v1.4.1) Minor update to better handle the versioning. This fixes an issue where the version number within Nautobot was not updated alongside the pyproject.toml. diff --git a/docs/admin/release_notes/version_1.5.md b/docs/admin/release_notes/version_1.5.md index 86b23057..d88ead04 100644 --- a/docs/admin/release_notes/version_1.5.md +++ b/docs/admin/release_notes/version_1.5.md @@ -1,7 +1,7 @@ # v1.5 Release Notes -## [v1.5.0](https://github.com/nautobot/nautobot-plugin-chatops/releases/tag/v1.5.0) +## [v1.5.0](https://github.com/nautobot/nautobot-app-chatops/releases/tag/v1.5.0) ### Updates @@ -10,10 +10,10 @@ ### Fixes -[#17](https://github.com/nautobot/nautobot-plugin-chatops/issues/17) - Error with filtering by empty regions, no message back +[#17](https://github.com/nautobot/nautobot-app-chatops/issues/17) - Error with filtering by empty regions, no message back -## [v1.5.1](https://github.com/nautobot/nautobot-plugin-chatops/releases/tag/v1.5.1) +## [v1.5.1](https://github.com/nautobot/nautobot-app-chatops/releases/tag/v1.5.1) ### Fixes -[#97](https://github.com/nautobot/nautobot-plugin-chatops/pull/97) Fixes MS Teams Bold markdown. Moves from `****` to `**` to align with guides from Microsoft +[#97](https://github.com/nautobot/nautobot-app-chatops/pull/97) Fixes MS Teams Bold markdown. Moves from `****` to `**` to align with guides from Microsoft diff --git a/docs/admin/release_notes/version_1.6.md b/docs/admin/release_notes/version_1.6.md index fa355432..4cd9f5f2 100644 --- a/docs/admin/release_notes/version_1.6.md +++ b/docs/admin/release_notes/version_1.6.md @@ -1,8 +1,8 @@ # v1.6 Release Notes -## [v1.6.0](https://github.com/nautobot/nautobot-plugin-chatops/releases/tag/v1.6.0) +## [v1.6.0](https://github.com/nautobot/nautobot-app-chatops/releases/tag/v1.6.0) ### Additions -[#123](https://github.com/nautobot/nautobot-plugin-chatops/pull/123) Added export button for chat command usage as CSV -[#120](https://github.com/nautobot/nautobot-plugin-chatops/pull/120) Added `send_all_messages_private` setting +[#123](https://github.com/nautobot/nautobot-app-chatops/pull/123) Added export button for chat command usage as CSV +[#120](https://github.com/nautobot/nautobot-app-chatops/pull/120) Added `send_all_messages_private` setting diff --git a/docs/admin/release_notes/version_1.7.md b/docs/admin/release_notes/version_1.7.md index 46c061b2..14a00434 100644 --- a/docs/admin/release_notes/version_1.7.md +++ b/docs/admin/release_notes/version_1.7.md @@ -1,20 +1,20 @@ # v1.7 Release Notes -## [v1.7.0](https://github.com/nautobot/nautobot-plugin-chatops/releases/tag/v1.7.0) +## [v1.7.0](https://github.com/nautobot/nautobot-app-chatops/releases/tag/v1.7.0) ### Additions -[#128](https://github.com/nautobot/nautobot-plugin-chatops/pull/128) Adds QOL change for focusing of fields +[#128](https://github.com/nautobot/nautobot-app-chatops/pull/128) Adds QOL change for focusing of fields ### Fixes -[#129](https://github.com/nautobot/nautobot-plugin-chatops/pull/129) Fixes errors on private messages -[#128](https://github.com/nautobot/nautobot-plugin-chatops/pull/128) Access grants updates +[#129](https://github.com/nautobot/nautobot-app-chatops/pull/129) Fixes errors on private messages +[#128](https://github.com/nautobot/nautobot-app-chatops/pull/128) Access grants updates -## [v1.7.1](https://github.com/nautobot/nautobot-plugin-chatops/releases/tag/v1.7.1) +## [v1.7.1](https://github.com/nautobot/nautobot-app-chatops/releases/tag/v1.7.1) ### What's Changed -* Fix slack msg limits by @jvanderaa in [#133](https://github.com/nautobot/nautobot-plugin-chatops/pull/133) +* Fix slack msg limits by @jvanderaa in [#133](https://github.com/nautobot/nautobot-app-chatops/pull/133) -[**Full Changelog**](https://github.com/nautobot/nautobot-plugin-chatops/compare/v1.7.0...v1.7.1) \ No newline at end of file +[**Full Changelog**](https://github.com/nautobot/nautobot-app-chatops/compare/v1.7.0...v1.7.1) \ No newline at end of file diff --git a/docs/admin/release_notes/version_1.8.md b/docs/admin/release_notes/version_1.8.md index 7d00bfe0..e15d6c4e 100644 --- a/docs/admin/release_notes/version_1.8.md +++ b/docs/admin/release_notes/version_1.8.md @@ -1,6 +1,6 @@ # v1.8 Release Notes -## [v1.8.0](https://github.com/nautobot/nautobot-plugin-chatops/releases/tag/v1.8.0) +## [v1.8.0](https://github.com/nautobot/nautobot-app-chatops/releases/tag/v1.8.0) ### What's Changed @@ -8,4 +8,4 @@ * Drop support for Nautobot <1.1.0 * Drop support for Python3.6 -[**Full Changelog**](https://github.com/nautobot/nautobot-plugin-chatops/compare/v1.7.1...v1.8.0) \ No newline at end of file +[**Full Changelog**](https://github.com/nautobot/nautobot-app-chatops/compare/v1.7.1...v1.8.0) \ No newline at end of file diff --git a/docs/admin/release_notes/version_1.9.md b/docs/admin/release_notes/version_1.9.md index 49163547..26af12a5 100644 --- a/docs/admin/release_notes/version_1.9.md +++ b/docs/admin/release_notes/version_1.9.md @@ -1,21 +1,21 @@ # v1.9 Release Notes -## [v1.9.1](https://github.com/nautobot/nautobot-plugin-chatops/releases/tag/v1.9.1) +## [v1.9.1](https://github.com/nautobot/nautobot-app-chatops/releases/tag/v1.9.1) ### What's Changed -* Fix broken docs link [#150](https://github.com/nautobot/nautobot-plugin-chatops/pull/150) and [#151](https://github.com/nautobot/nautobot-plugin-chatops/pull/151) +* Fix broken docs link [#150](https://github.com/nautobot/nautobot-app-chatops/pull/150) and [#151](https://github.com/nautobot/nautobot-app-chatops/pull/151) -[**Full Changelog**](https://github.com/nautobot/nautobot-plugin-chatops/compare/v1.9.0...v1.9.1) +[**Full Changelog**](https://github.com/nautobot/nautobot-app-chatops/compare/v1.9.0...v1.9.1) -## [v1.9.0](https://github.com/nautobot/nautobot-plugin-chatops/releases/tag/v1.9.0) +## [v1.9.0](https://github.com/nautobot/nautobot-app-chatops/releases/tag/v1.9.0) ### What's Changed * Add support for Nautobot 1.4.0 * Drop support for Nautobot <1.2.0 -* Remove missing action banner [#140](https://github.com/nautobot/nautobot-plugin-chatops/pull/140) -* Fix Mattermost API MattermostInteractionView request_schema [#144](https://github.com/nautobot/nautobot-plugin-chatops/pull/144) +* Remove missing action banner [#140](https://github.com/nautobot/nautobot-app-chatops/pull/140) +* Fix Mattermost API MattermostInteractionView request_schema [#144](https://github.com/nautobot/nautobot-app-chatops/pull/144) -[**Full Changelog**](https://github.com/nautobot/nautobot-plugin-chatops/compare/v1.8.0...v1.9.0) +[**Full Changelog**](https://github.com/nautobot/nautobot-app-chatops/compare/v1.8.0...v1.9.0) diff --git a/docs/admin/release_notes/version_2.0.md b/docs/admin/release_notes/version_2.0.md index 10c7f6ea..329f6735 100644 --- a/docs/admin/release_notes/version_2.0.md +++ b/docs/admin/release_notes/version_2.0.md @@ -2,55 +2,55 @@ # v2.0 Release Notes -## [v2.0.3 (2023-09-22)](https://github.com/nautobot/nautobot-plugin-chatops/releases/tag/v2.0.3) +## [v2.0.3 (2023-09-22)](https://github.com/nautobot/nautobot-app-chatops/releases/tag/v2.0.3) ### Added -- [#227](https://github.com/nautobot/nautobot-plugin-chatops/issues/227) - Added some tests for VLAN chatops. +- [#227](https://github.com/nautobot/nautobot-app-chatops/issues/227) - Added some tests for VLAN chatops. ### Fixed -- [#227](https://github.com/nautobot/nautobot-plugin-chatops/issues/227) - Fixed parameters that should be set to None if they have not been defined yet by default. -- [#239](https://github.com/nautobot/nautobot-plugin-chatops/issues/239) - Updated IP Fabric Logo. -- [#241](https://github.com/nautobot/nautobot-plugin-chatops/issues/241) - Remove Grafana Navigation and urls if disabled. -- [#253](https://github.com/nautobot/nautobot-plugin-chatops/issues/253) - Sorted the ICMP types from IP Fabric diagrams package. +- [#227](https://github.com/nautobot/nautobot-app-chatops/issues/227) - Fixed parameters that should be set to None if they have not been defined yet by default. +- [#239](https://github.com/nautobot/nautobot-app-chatops/issues/239) - Updated IP Fabric Logo. +- [#241](https://github.com/nautobot/nautobot-app-chatops/issues/241) - Remove Grafana Navigation and urls if disabled. +- [#253](https://github.com/nautobot/nautobot-app-chatops/issues/253) - Sorted the ICMP types from IP Fabric diagrams package. -## [v2.0.2 (2023-08-11)](https://github.com/nautobot/nautobot-plugin-chatops/releases/tag/v2.0.2) +## [v2.0.2 (2023-08-11)](https://github.com/nautobot/nautobot-app-chatops/releases/tag/v2.0.2) ### Changed -- [#233](https://github.com/nautobot/nautobot-plugin-chatops/pull/233) - Fixed App initialization when `[grafana]` extra is not installed. +- [#233](https://github.com/nautobot/nautobot-app-chatops/pull/233) - Fixed App initialization when `[grafana]` extra is not installed. -## [v2.0.1 (2023-08-08)](https://github.com/nautobot/nautobot-plugin-chatops/releases/tag/v2.0.1) +## [v2.0.1 (2023-08-08)](https://github.com/nautobot/nautobot-app-chatops/releases/tag/v2.0.1) ### Changed -- [#228](https://github.com/nautobot/nautobot-plugin-chatops/issues/228) - Move Contributing Changelog Fragments higher in documentation +- [#228](https://github.com/nautobot/nautobot-app-chatops/issues/228) - Move Contributing Changelog Fragments higher in documentation -## [v2.0.0 (2023-08-02)](https://github.com/nautobot/nautobot-plugin-chatops/releases/tag/v2.0.0) +## [v2.0.0 (2023-08-02)](https://github.com/nautobot/nautobot-app-chatops/releases/tag/v2.0.0) ### Added -- [#67](https://github.com/nautobot/nautobot-plugin-chatops/issues/67) - Added the ability within Slack to mention the chat bot by name in a channel and in threads. -- [#194](https://github.com/nautobot/nautobot-plugin-chatops/issues/194) - Added Mattermost container for the development. -- [#194](https://github.com/nautobot/nautobot-plugin-chatops/issues/194) - Improved invoke tasks. -- [#197](https://github.com/nautobot/nautobot-plugin-chatops/issues/197) - Add a try/except block and error logger message when access_token missing from get_token() response. -- [#202](https://github.com/nautobot/nautobot-plugin-chatops/issues/202) - Added Ansible integration from nautobot-plugin-chatops-ansible. -- [#203](https://github.com/nautobot/nautobot-plugin-chatops/issues/203) - Added IP Fabric integration from nautobot-plugin-chatops-ipfabric. -- [#204](https://github.com/nautobot/nautobot-plugin-chatops/issues/204) - Added Arista CloudVision integration from nautobot-plugin-chatops-arista-cloudvision. -- [#205](https://github.com/nautobot/nautobot-plugin-chatops/issues/205) - Added Cisco Meraki integration from nautobot-plugin-chatops-meraki. -- [#206](https://github.com/nautobot/nautobot-plugin-chatops/issues/206) - Added Cisco ACI integration from nautobot-plugin-chatops-aci. -- [#207](https://github.com/nautobot/nautobot-plugin-chatops/issues/207) - Added Panorama integration from nautobot-plugin-chatops-panorama -- [#208](https://github.com/nautobot/nautobot-plugin-chatops/issues/208) - Added Grafana integration from nautobot-plugin-chatops-grafana. +- [#67](https://github.com/nautobot/nautobot-app-chatops/issues/67) - Added the ability within Slack to mention the chat bot by name in a channel and in threads. +- [#194](https://github.com/nautobot/nautobot-app-chatops/issues/194) - Added Mattermost container for the development. +- [#194](https://github.com/nautobot/nautobot-app-chatops/issues/194) - Improved invoke tasks. +- [#197](https://github.com/nautobot/nautobot-app-chatops/issues/197) - Add a try/except block and error logger message when access_token missing from get_token() response. +- [#202](https://github.com/nautobot/nautobot-app-chatops/issues/202) - Added Ansible integration from nautobot-plugin-chatops-ansible. +- [#203](https://github.com/nautobot/nautobot-app-chatops/issues/203) - Added IP Fabric integration from nautobot-plugin-chatops-ipfabric. +- [#204](https://github.com/nautobot/nautobot-app-chatops/issues/204) - Added Arista CloudVision integration from nautobot-plugin-chatops-arista-cloudvision. +- [#205](https://github.com/nautobot/nautobot-app-chatops/issues/205) - Added Cisco Meraki integration from nautobot-plugin-chatops-meraki. +- [#206](https://github.com/nautobot/nautobot-app-chatops/issues/206) - Added Cisco ACI integration from nautobot-plugin-chatops-aci. +- [#207](https://github.com/nautobot/nautobot-app-chatops/issues/207) - Added Panorama integration from nautobot-plugin-chatops-panorama +- [#208](https://github.com/nautobot/nautobot-app-chatops/issues/208) - Added Grafana integration from nautobot-plugin-chatops-grafana. ### Changed -- [#67](https://github.com/nautobot/nautobot-plugin-chatops/issues/67) - Modified the clear command to not work within Slack threads. -- [#196](https://github.com/nautobot/nautobot-plugin-chatops/issues/196) - Update to microsoft IPs and correcting the one in the doc. -- [#218](https://github.com/nautobot/nautobot-plugin-chatops/issues/218) - Added `/clear` command to development Mattermost. -- [#218](https://github.com/nautobot/nautobot-plugin-chatops/issues/218) - Improved integration workers loading. -- [#218](https://github.com/nautobot/nautobot-plugin-chatops/issues/218) - Sorted App config and environment variables. -- [#218](https://github.com/nautobot/nautobot-plugin-chatops/issues/218) - Sorted pyproject configurations. +- [#67](https://github.com/nautobot/nautobot-app-chatops/issues/67) - Modified the clear command to not work within Slack threads. +- [#196](https://github.com/nautobot/nautobot-app-chatops/issues/196) - Update to microsoft IPs and correcting the one in the doc. +- [#218](https://github.com/nautobot/nautobot-app-chatops/issues/218) - Added `/clear` command to development Mattermost. +- [#218](https://github.com/nautobot/nautobot-app-chatops/issues/218) - Improved integration workers loading. +- [#218](https://github.com/nautobot/nautobot-app-chatops/issues/218) - Sorted App config and environment variables. +- [#218](https://github.com/nautobot/nautobot-app-chatops/issues/218) - Sorted pyproject configurations. ### Removed diff --git a/docs/admin/release_notes/version_2.1.md b/docs/admin/release_notes/version_2.1.md index 00cdf009..c8eb5399 100644 --- a/docs/admin/release_notes/version_2.1.md +++ b/docs/admin/release_notes/version_2.1.md @@ -2,8 +2,8 @@ # v2.1 Release Notes -## [v2.1.0 (2023-09-28)](https://github.com/nautobot/nautobot-plugin-chatops/releases/tag/v2.1.0) +## [v2.1.0 (2023-09-28)](https://github.com/nautobot/nautobot-app-chatops/releases/tag/v2.1.0) ### Fixed -- [#273](https://github.com/nautobot/nautobot-plugin-chatops/issues/273) - Fixed dependency resolution issues with latest release of golden config. +- [#273](https://github.com/nautobot/nautobot-app-chatops/issues/273) - Fixed dependency resolution issues with latest release of golden config. diff --git a/docs/admin/release_notes/version_3.0.md b/docs/admin/release_notes/version_3.0.md index 0e8c7b57..0c5ecaff 100644 --- a/docs/admin/release_notes/version_3.0.md +++ b/docs/admin/release_notes/version_3.0.md @@ -2,15 +2,15 @@ # v3.0 Release Notes -## [v3.0.0 (2023-09-29)](https://github.com/nautobot/nautobot-plugin-chatops/releases/tag/v3.0.0) +## [v3.0.0 (2023-09-29)](https://github.com/nautobot/nautobot-app-chatops/releases/tag/v3.0.0) ### Added -- [#112](https://github.com/nautobot/nautobot-plugin-chatops/issues/112) - Add ability to link Chat User with Nautobot User. -- [#272](https://github.com/nautobot/nautobot-plugin-chatops/issues/272) - Add ObjectNotesView for ChatOps models. +- [#112](https://github.com/nautobot/nautobot-app-chatops/issues/112) - Add ability to link Chat User with Nautobot User. +- [#272](https://github.com/nautobot/nautobot-app-chatops/issues/272) - Add ObjectNotesView for ChatOps models. -## [v3.0.1 (2023-09-29)](https://github.com/nautobot/nautobot-plugin-chatops/releases/tag/v3.0.1) +## [v3.0.1 (2023-09-29)](https://github.com/nautobot/nautobot-app-chatops/releases/tag/v3.0.1) ### Fixed -- [[#281](https://github.com/nautobot/nautobot-plugin-chatops/issues/281) - Address permissions bug found during release review. \ No newline at end of file +- [[#281](https://github.com/nautobot/nautobot-app-chatops/issues/281) - Address permissions bug found during release review. \ No newline at end of file diff --git a/docs/admin/uninstall.md b/docs/admin/uninstall.md index c97c2677..64fa2e75 100644 --- a/docs/admin/uninstall.md +++ b/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_chatops zero +nautobot-server migrate nautobot_chatops zero ``` ## Remove App configuration diff --git a/docs/admin/upgrade.md b/docs/admin/upgrade.md index 277ec674..6c8becb4 100644 --- a/docs/admin/upgrade.md +++ b/docs/admin/upgrade.md @@ -4,7 +4,7 @@ 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-chatops` 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-chatops` package via `pip`. ### Upgrading to ChatOps 3.0 diff --git a/docs/dev/contributing.md b/docs/dev/contributing.md index ef84502f..92d54b58 100644 --- a/docs/dev/contributing.md +++ b/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. diff --git a/docs/dev/design.md b/docs/dev/design.md index 9628e6e1..0e4a0422 100644 --- a/docs/dev/design.md +++ b/docs/dev/design.md @@ -1,6 +1,6 @@ # The design of Nautobot ChatOps -By delivering this as a Nautobot ChatOps plugin, we gain the following benefits: +By delivering this as a Nautobot ChatOps App, we gain the following benefits: - No need to stand up a separate HTTP server, just use Nautobot's own HTTP server. - Use of `async` is not required because we can hand off long-running tasks to Nautobot's `celery` workers. With one notable exception, WebSocket connections will be done with `async`. We have opted for `AIOHTTP` for our WebSocket [clients](https://docs.aiohttp.org/en/stable/client_quickstart.html#aiohttp-client-websockets). @@ -12,7 +12,7 @@ By delivering this as a Nautobot ChatOps plugin, we gain the following benefits: ## Code structure -The design goal of this plugin is to be able to write chatbot commands once and have them run anywhere +The design goal of this app is to be able to write chatbot commands once and have them run anywhere (Slack, Microsoft Teams, Cisco Webex, etc.). Toward that end, it's divided into three layers: 1. input @@ -39,8 +39,8 @@ The design goal of this plugin is to be able to write chatbot commands once and - In addition to enqueuing the command parameters for the worker, the queue also requires a `Dispatcher` class (see below) and any additional `context` that the dispatcher requires (such as user_id, channel_id, tokens, etc.) - - Support for additional chat platform endpoints can be implemented as additional modules in this plugin, - or could be delivered as an entirely separate Nautobot plugin if desired. + - Support for additional chat platform endpoints can be implemented as additional modules in this app, + or could be delivered as an entirely separate Nautobot app if desired. 2. worker (`nautobot_chatops.workers`) @@ -54,7 +54,7 @@ The design goal of this plugin is to be able to write chatbot commands once and - Each module in this layer would provide a different top-level command, such as `nautobot`, `grafana`, or `ansible`. - This layer is designed to be extensible through Python's packaging `entry_points` functionality (`plugins` in - Poetry's terminology). A Python package (Nautobot plugin) can register any worker functions under the `nautobot.workers` entry point, + Poetry's terminology). A Python package (Nautobot App) can register any worker functions under the `nautobot.workers` entry point, and the worker(s) will automatically be added to the client's capabilities. 3. output (`nautobot_chatops.dispatchers`) @@ -78,7 +78,7 @@ The design goal of this plugin is to be able to write chatbot commands once and `views` submodules and `dispatchers` submodules. - As with the `views` layer, the `Dispatcher` for a new chat platform could be implemented as a new submodule for - this plugin, or could be delivered as part of a separate Nautobot plugin. + this app, or could be delivered as part of a separate Nautobot App. ## Information flow diff --git a/docs/dev/dev_environment.md b/docs/dev/dev_environment.md index b4067e76..0df8915f 100644 --- a/docs/dev/dev_environment.md +++ b/docs/dev/dev_environment.md @@ -35,7 +35,7 @@ This project is managed by [Python Poetry](https://python-poetry.org/) and has a Once you have Poetry and Docker installed you can run the following commands (in the root of the repository) to install all other development dependencies in an isolated Python virtual environment: ```shell -git clone git@github.com:nautobot/nautobot-plugin-chatops.git +git clone git@github.com:nautobot/nautobot-app-chatops.git cd nautobot-plugin-chatops poetry shell poetry install @@ -135,8 +135,8 @@ Each command can be executed with `invoke `. 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 @@ -298,9 +298,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). @@ -350,7 +350,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 @@ -365,18 +365,18 @@ 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 Nautobot ChatOps. 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 Nautobot ChatOps. 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 @@ -384,7 +384,7 @@ Before you continue, you'll need to update the file `development/nautobot_config ➜ 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 `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. diff --git a/docs/dev/release_checklist.md b/docs/dev/release_checklist.md index f859c96c..71ad060f 100644 --- a/docs/dev/release_checklist.md +++ b/docs/dev/release_checklist.md @@ -143,7 +143,7 @@ Once CI has completed on the PR, merge it. ### Create a New Release -Draft a [new release](https://github.com/nautobot/nautobot-plugin-chatops/releases/new) with the following parameters. +Draft a [new release](https://github.com/nautobot/nautobot-app-chatops/releases/new) with the following parameters. * **Tag:** Current version (e.g. `v1.0.0`) * **Target:** `main` diff --git a/docs/models/commandtoken.md b/docs/models/commandtoken.md index ef34d1c7..1b10e073 100644 --- a/docs/models/commandtoken.md +++ b/docs/models/commandtoken.md @@ -7,7 +7,7 @@ Some platforms this `signing_secret` is valid for all commands, other platforms, create a separate `token` for every slash command. Keeping the records for Mattermost tokens in the `.creds.env` file would not be sustainable. -To solve this issue, the plugin has the option to store Command Tokens to the Nautobot Database. +To solve this issue, the app has the option to store Command Tokens to the Nautobot Database. In Nautobot, open Nautobot and go to the Plugins and select Command Tokens. Below is an example to get you started. diff --git a/docs/user/app_overview.md b/docs/user/app_overview.md index aaf87b1a..0e8a188f 100644 --- a/docs/user/app_overview.md +++ b/docs/user/app_overview.md @@ -7,7 +7,7 @@ This document provides an overview of the App including critical information and ## Description -The ChatOps framework provides Network Engineers power to query Nautobot or their Network (through ChatOps plugins) while staying within their preferred Chat application. The goal of ChatOps is to bring people, processes and Automation together. +The ChatOps framework provides Network Engineers power to query Nautobot or their Network (through ChatOps apps) while staying within their preferred Chat application. The goal of ChatOps is to bring people, processes and Automation together. {% include-markdown '../glossary.md' diff --git a/docs/user/ipfabric_commands.md b/docs/user/ipfabric_commands.md index 053c0941..401ea31c 100644 --- a/docs/user/ipfabric_commands.md +++ b/docs/user/ipfabric_commands.md @@ -21,7 +21,7 @@ Interact with IPFabric by utilizing the following sub-commands: !!! note All sub-commands are intended to be used with the `/ipfabric` prefix. -IP Fabric uses a concept of snapshots which can include different devices and data. The plugin supports querying specific snapshots via the `/ipfabric set-snapshot` command. The snapshot is set per user and cached for all future commands. If a snapshot is not set, the commands will default to `$last` unless a specific snapshot id is required. +IP Fabric uses a concept of snapshots which can include different devices and data. The app supports querying specific snapshots via the `/ipfabric set-snapshot` command. The snapshot is set per user and cached for all future commands. If a snapshot is not set, the commands will default to `$last` unless a specific snapshot id is required. ## Screenshots diff --git a/mkdocs.yml b/mkdocs.yml index 64298e45..8fdc6bf3 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,10 +1,10 @@ --- dev_addr: "127.0.0.1:8001" -edit_uri: "edit/main/nautobot-plugin-chatops/docs" +edit_uri: "edit/main/nautobot-app-chatops/docs" site_dir: "nautobot_chatops/static/nautobot_chatops/docs" site_name: "Nautobot ChatOps App Documentation" site_url: "https://docs.nautobot.com/projects/chatops/en/latest/" -repo_url: "https://github.com/nautobot/nautobot-plugin-chatops/" +repo_url: "https://github.com/nautobot/nautobot-app-chatops/" copyright: "Copyright © The Authors" theme: name: "material" diff --git a/nautobot_chatops/__init__.py b/nautobot_chatops/__init__.py index d180c074..30763085 100644 --- a/nautobot_chatops/__init__.py +++ b/nautobot_chatops/__init__.py @@ -1,4 +1,4 @@ -"""Plugin declaration for nautobot_chatops.""" +"""App declaration for nautobot_chatops.""" # Metadata is inherited from Nautobot. If not including Nautobot in the environment, this should be added from importlib import metadata @@ -32,7 +32,7 @@ def _check_for_conflicting_apps(): class NautobotChatOpsConfig(NautobotAppConfig): - """Plugin configuration for the nautobot_chatops plugin.""" + """App configuration for the nautobot_chatops app.""" name = "nautobot_chatops" verbose_name = "Nautobot ChatOps" @@ -51,7 +51,7 @@ class NautobotChatOpsConfig(NautobotAppConfig): # Should menus, text input fields, etc. be deleted from the chat history after the user makes a selection? "delete_input_on_submission": False, "restrict_help": False, - # As requested on https://github.com/nautobot/nautobot-plugin-chatops/issues/114 this setting is used for + # As requested on https://github.com/nautobot/nautobot-app-chatops/issues/114 this setting is used for # sending all messages as an ephemeral message, meaning only the person interacting with the bot will see the # responses. "send_all_messages_private": False, @@ -147,7 +147,7 @@ class NautobotChatOpsConfig(NautobotAppConfig): caching_config = {} def ready(self): - """Function invoked after all plugins have been loaded.""" + """Function invoked after all apps have been loaded.""" super().ready() # pylint: disable=import-outside-toplevel from nautobot_capacity_metrics import register_metric_func diff --git a/nautobot_chatops/admin.py b/nautobot_chatops/admin.py index 917b355d..53b3f889 100644 --- a/nautobot_chatops/admin.py +++ b/nautobot_chatops/admin.py @@ -1,4 +1,4 @@ -"""Administrative capabilities for nautobot_chatops plugin.""" +"""Administrative capabilities for nautobot_chatops app.""" from django.contrib import admin from .models import ChatOpsAccountLink, CommandLog diff --git a/nautobot_chatops/api/__init__.py b/nautobot_chatops/api/__init__.py index 81763b58..f5329948 100644 --- a/nautobot_chatops/api/__init__.py +++ b/nautobot_chatops/api/__init__.py @@ -1 +1 @@ -"""REST API module for nautobot_chatops plugin.""" +"""REST API module for nautobot_chatops app.""" diff --git a/nautobot_chatops/api/serializers.py b/nautobot_chatops/api/serializers.py index 583095ee..d0cac19d 100644 --- a/nautobot_chatops/api/serializers.py +++ b/nautobot_chatops/api/serializers.py @@ -1,4 +1,4 @@ -"""API Serializers for ChatOps Plugin.""" +"""API Serializers for ChatOps App.""" from rest_framework import serializers diff --git a/nautobot_chatops/api/urls.py b/nautobot_chatops/api/urls.py index a2238616..9443a98d 100644 --- a/nautobot_chatops/api/urls.py +++ b/nautobot_chatops/api/urls.py @@ -1,4 +1,4 @@ -"""Django urlpatterns declaration for nautobot_chatops plugin.""" +"""Django urlpatterns declaration for nautobot_chatops app.""" import logging diff --git a/nautobot_chatops/api/views/__init__.py b/nautobot_chatops/api/views/__init__.py index 86df9e84..1fa340b0 100644 --- a/nautobot_chatops/api/views/__init__.py +++ b/nautobot_chatops/api/views/__init__.py @@ -1,4 +1,4 @@ -"""API Views module for the nautobot_chatops Nautobot plugin. +"""API Views module for the nautobot_chatops Nautobot App. The views implemented in this module act as endpoints for various chat platforms to send requests and notifications to. diff --git a/nautobot_chatops/api/views/webex.py b/nautobot_chatops/api/views/webex.py index 3c449aa3..0e014e52 100644 --- a/nautobot_chatops/api/views/webex.py +++ b/nautobot_chatops/api/views/webex.py @@ -42,7 +42,7 @@ API = None BOT_ID = None -# TODO: the plugin should verify that the webhooks are correctly set up, or else make API calls to create them +# TODO: the app should verify that the webhooks are correctly set up, or else make API calls to create them def generate_signature(request): diff --git a/nautobot_chatops/constants.py b/nautobot_chatops/constants.py index ca668c60..22f46662 100644 --- a/nautobot_chatops/constants.py +++ b/nautobot_chatops/constants.py @@ -1,4 +1,4 @@ -"""Static variables used in plugin.""" +"""Static variables used in app.""" COMMAND_LOG_USER_NAME_HELP_TEXT = "Invoking username" COMMAND_LOG_USER_ID_HELP_TEXT = "Invoking user ID" diff --git a/nautobot_chatops/dispatchers/__init__.py b/nautobot_chatops/dispatchers/__init__.py index 71ff9a0f..f93daef7 100644 --- a/nautobot_chatops/dispatchers/__init__.py +++ b/nautobot_chatops/dispatchers/__init__.py @@ -1,4 +1,4 @@ -"""Dispatchers module for the nautobot_chatops Nautobot plugin. +"""Dispatchers module for the nautobot_chatops Nautobot App. The classes implemented in this module implement a common API for "dispatching" content (plaintext messages, formatted text, UI elements, etc.) to the user of a given chat platform. diff --git a/nautobot_chatops/dispatchers/base.py b/nautobot_chatops/dispatchers/base.py index 9bf67da6..2bbf4836 100644 --- a/nautobot_chatops/dispatchers/base.py +++ b/nautobot_chatops/dispatchers/base.py @@ -64,7 +64,7 @@ def user(self): return user def _get_cache_key(self) -> str: - """Key generator for the cache, adding the plugin prefix name.""" + """Key generator for the cache, adding the app prefix name.""" # Using __file__ as a key customization within the cache return "-".join([__file__, self.context.get("user_id", "generic")]) diff --git a/nautobot_chatops/integrations/aci/worker.py b/nautobot_chatops/integrations/aci/worker.py index 71c8288b..cb2652bf 100644 --- a/nautobot_chatops/integrations/aci/worker.py +++ b/nautobot_chatops/integrations/aci/worker.py @@ -36,7 +36,7 @@ def _read_settings(): @nautobot_task def aci(subcommand, **kwargs): - """Interact with aci plugin.""" + """Interact with aci app.""" return handle_subcommands("aci", subcommand, **kwargs) diff --git a/nautobot_chatops/integrations/ansible/tower.py b/nautobot_chatops/integrations/ansible/tower.py index fab4d4e4..a8d07914 100644 --- a/nautobot_chatops/integrations/ansible/tower.py +++ b/nautobot_chatops/integrations/ansible/tower.py @@ -59,9 +59,7 @@ def __init__( self.origin = origin self.extra_vars = {} if not self.uri or not self.username or not self.password: - raise ValueError( - "Missing required parameters for Tower access - check environment and plugin configuration" - ) + raise ValueError("Missing required parameters for Tower access - check environment and app configuration") def _launch_job(self, template_name, extra_vars): """Launch a playbook in Ansible Tower. diff --git a/nautobot_chatops/integrations/grafana/api/urls.py b/nautobot_chatops/integrations/grafana/api/urls.py index 1e2a5c67..2ccef219 100644 --- a/nautobot_chatops/integrations/grafana/api/urls.py +++ b/nautobot_chatops/integrations/grafana/api/urls.py @@ -1,4 +1,4 @@ -"""Django urlpatterns declaration for nautobot_chatops.integrations.grafana plugin.""" +"""Django urlpatterns declaration for nautobot_chatops.integrations.grafana app.""" from nautobot.apps.api import OrderedDefaultRouter from nautobot.apps.config import get_app_settings_or_config diff --git a/nautobot_chatops/integrations/grafana/api/views/__init__.py b/nautobot_chatops/integrations/grafana/api/views/__init__.py index 85c920fb..752d6639 100644 --- a/nautobot_chatops/integrations/grafana/api/views/__init__.py +++ b/nautobot_chatops/integrations/grafana/api/views/__init__.py @@ -1,4 +1,4 @@ -"""API Views module for the nautobot_chatops.integrations.grafana Nautobot plugin. +"""API Views module for the nautobot_chatops.integrations.grafana Nautobot App. The views implemented in this module act as endpoints for various chat platforms to send requests and notifications to. diff --git a/nautobot_chatops/integrations/grafana/api/views/generic.py b/nautobot_chatops/integrations/grafana/api/views/generic.py index 4fdad892..da24c2cb 100644 --- a/nautobot_chatops/integrations/grafana/api/views/generic.py +++ b/nautobot_chatops/integrations/grafana/api/views/generic.py @@ -1,4 +1,4 @@ -"""API Views for Nautobot Plugin Chatops Grafana.""" +"""API Views for Nautobot App Chatops Grafana.""" from rest_framework.routers import APIRootView diff --git a/nautobot_chatops/integrations/grafana/exceptions.py b/nautobot_chatops/integrations/grafana/exceptions.py index 6763f514..38975e7d 100644 --- a/nautobot_chatops/integrations/grafana/exceptions.py +++ b/nautobot_chatops/integrations/grafana/exceptions.py @@ -1,4 +1,4 @@ -"""Nautobot Plugin ChatOps Grafana Exceptions.""" +"""Nautobot App ChatOps Grafana Exceptions.""" from pydantic import ValidationError from isodate import ISO8601Error diff --git a/nautobot_chatops/integrations/grafana/tables.py b/nautobot_chatops/integrations/grafana/tables.py index 06ef8ce5..a8f9ec67 100644 --- a/nautobot_chatops/integrations/grafana/tables.py +++ b/nautobot_chatops/integrations/grafana/tables.py @@ -6,7 +6,7 @@ class DashboardViewTable(BaseTable): - """Table for rendering panels for dashboards in the grafana plugin.""" + """Table for rendering panels for dashboards in the grafana app.""" pk = ToggleColumn() @@ -20,7 +20,7 @@ class Meta(BaseTable.Meta): # pylint: disable=too-few-public-methods class PanelViewTable(BaseTable): - """Table for rendering panels for dashboards in the grafana plugin.""" + """Table for rendering panels for dashboards in the grafana app.""" pk = ToggleColumn() @@ -40,7 +40,7 @@ class Meta(BaseTable.Meta): # pylint: disable=too-few-public-methods class PanelVariableViewTable(BaseTable): - """Table for rendering panel variables for dashboards in the grafana plugin.""" + """Table for rendering panel variables for dashboards in the grafana app.""" pk = ToggleColumn() diff --git a/nautobot_chatops/integrations/grafana/urls.py b/nautobot_chatops/integrations/grafana/urls.py index 96c67b7e..1f1f7b25 100644 --- a/nautobot_chatops/integrations/grafana/urls.py +++ b/nautobot_chatops/integrations/grafana/urls.py @@ -1,4 +1,4 @@ -"""Django urlpatterns declaration for nautobot_chatops.integrations.grafana plugin.""" +"""Django urlpatterns declaration for nautobot_chatops.integrations.grafana app.""" from django.urls import path from nautobot.extras.views import ObjectChangeLogView from nautobot_chatops.integrations.grafana.models import Dashboard, PanelVariable, Panel diff --git a/nautobot_chatops/integrations/grafana/views.py b/nautobot_chatops/integrations/grafana/views.py index 1ae3a045..09fbc5bc 100644 --- a/nautobot_chatops/integrations/grafana/views.py +++ b/nautobot_chatops/integrations/grafana/views.py @@ -1,4 +1,4 @@ -"""Views module for the nautobot_chatops.integrations.grafana plugin. +"""Views module for the nautobot_chatops.integrations.grafana App. The views implemented in this module act as endpoints for various chat platforms to send requests and notifications to. diff --git a/nautobot_chatops/integrations/ipfabric/context.py b/nautobot_chatops/integrations/ipfabric/context.py index 2cff7ab2..b8e2f38b 100644 --- a/nautobot_chatops/integrations/ipfabric/context.py +++ b/nautobot_chatops/integrations/ipfabric/context.py @@ -5,7 +5,7 @@ def _get_cache_key(user: str) -> str: - """Key generator for the cache, adding the plugin prefix name.""" + """Key generator for the cache, adding the app prefix name.""" key_string = "-".join([NautobotChatOpsConfig.name, user]) return hashlib.md5(key_string.encode("utf-8")).hexdigest() # nosec diff --git a/nautobot_chatops/integrations/ipfabric/worker.py b/nautobot_chatops/integrations/ipfabric/worker.py index a9dda45b..4957336d 100644 --- a/nautobot_chatops/integrations/ipfabric/worker.py +++ b/nautobot_chatops/integrations/ipfabric/worker.py @@ -51,7 +51,7 @@ def ipfabric_logo(dispatcher): def ipfabric(subcommand, **kwargs): - """Interact with ipfabric plugin.""" + """Interact with ipfabric app.""" return handle_subcommands("ipfabric", subcommand, **kwargs) diff --git a/nautobot_chatops/integrations/panorama/worker.py b/nautobot_chatops/integrations/panorama/worker.py index 22acc2cb..799dfa60 100644 --- a/nautobot_chatops/integrations/panorama/worker.py +++ b/nautobot_chatops/integrations/panorama/worker.py @@ -565,7 +565,7 @@ def capture_traffic( """Capture IP traffic on PANOS Device. Args: - dispatcher (object): Chatops plugin dispatcher object + dispatcher (object): Chatops app dispatcher object device (str): Device name snet (str): Source IP/network in IPv4 CIDR notation dnet (str): Destination IP/network in IPv4 CIDR notation diff --git a/nautobot_chatops/metrics.py b/nautobot_chatops/metrics.py index 6ef23428..4401bdb4 100644 --- a/nautobot_chatops/metrics.py +++ b/nautobot_chatops/metrics.py @@ -1,4 +1,4 @@ -"""Nautobot plugin metrics exposed through nautobot_metrics_ext.""" +"""Nautobot app metrics exposed through nautobot_metrics_ext.""" from prometheus_client import Counter, Histogram, Summary diff --git a/nautobot_chatops/metrics_app.py b/nautobot_chatops/metrics_app.py index 2485911d..2cc6e6d0 100644 --- a/nautobot_chatops/metrics_app.py +++ b/nautobot_chatops/metrics_app.py @@ -1,4 +1,4 @@ -"""Nautobot plugin application level metrics exposed through nautobot_metrics_ext.""" +"""Nautobot app application level metrics exposed through nautobot_metrics_ext.""" from prometheus_client.core import CounterMetricFamily diff --git a/nautobot_chatops/navigation.py b/nautobot_chatops/navigation.py index 8baaa557..3bd9ec7b 100644 --- a/nautobot_chatops/navigation.py +++ b/nautobot_chatops/navigation.py @@ -1,4 +1,4 @@ -"""Plugin additions to the Nautobot navigation menu.""" +"""App additions to the Nautobot navigation menu.""" from nautobot.apps.config import get_app_settings_or_config from nautobot.apps.ui import NavMenuAddButton, NavMenuGroup, NavMenuItem, NavMenuTab diff --git a/nautobot_chatops/tests/__init__.py b/nautobot_chatops/tests/__init__.py index 102ef4fd..ead6aa80 100644 --- a/nautobot_chatops/tests/__init__.py +++ b/nautobot_chatops/tests/__init__.py @@ -1 +1 @@ -"""Unit tests for nautobot_chatops plugin.""" +"""Unit tests for nautobot_chatops app.""" diff --git a/nautobot_chatops/tests/aci/__init__.py b/nautobot_chatops/tests/aci/__init__.py index 0991627c..daad5815 100644 --- a/nautobot_chatops/tests/aci/__init__.py +++ b/nautobot_chatops/tests/aci/__init__.py @@ -1 +1 @@ -"""Unit tests for integrations.aci plugin.""" +"""Unit tests for integrations.aci app.""" diff --git a/nautobot_chatops/tests/ansible/__init__.py b/nautobot_chatops/tests/ansible/__init__.py index 8cac59da..bea26431 100644 --- a/nautobot_chatops/tests/ansible/__init__.py +++ b/nautobot_chatops/tests/ansible/__init__.py @@ -1 +1 @@ -"""Unit tests for nautobot_chatops.integrations.ansible plugin.""" +"""Unit tests for nautobot_chatops.integrations.ansible app.""" diff --git a/nautobot_chatops/tests/grafana/__init__.py b/nautobot_chatops/tests/grafana/__init__.py index d914107c..ebfa6dfe 100644 --- a/nautobot_chatops/tests/grafana/__init__.py +++ b/nautobot_chatops/tests/grafana/__init__.py @@ -1 +1 @@ -"""Unit tests for nautobot_chatops.integrations.grafana plugin.""" +"""Unit tests for nautobot_chatops.integrations.grafana app.""" diff --git a/nautobot_chatops/tests/grafana/test_workers.py b/nautobot_chatops/tests/grafana/test_workers.py index 36f5f7a7..2707c037 100644 --- a/nautobot_chatops/tests/grafana/test_workers.py +++ b/nautobot_chatops/tests/grafana/test_workers.py @@ -142,7 +142,7 @@ def test_get_commands_registry_dynamic_subcommands(self): self.assertIn("nautobot", registry) def test_grafana_commands_registry_dynamic_subcommands(self): - """Specific testing for the Grafana Chatops Plugin.""" + """Specific testing for the Grafana Chatops App.""" with dynamic_entrypoint("nautobot.workers", name="grafana", module="nautobot_chatops.grafana.worker"): registry = get_commands_registry() diff --git a/nautobot_chatops/tests/panorama/__init__.py b/nautobot_chatops/tests/panorama/__init__.py index f762864e..e61712ea 100644 --- a/nautobot_chatops/tests/panorama/__init__.py +++ b/nautobot_chatops/tests/panorama/__init__.py @@ -1 +1 @@ -"""Unit tests for nautobot_plugin.integrations.panorama plugin.""" +"""Unit tests for nautobot_plugin.integrations.panorama app.""" diff --git a/nautobot_chatops/urls.py b/nautobot_chatops/urls.py index 6f02d1ee..8da8f0ac 100644 --- a/nautobot_chatops/urls.py +++ b/nautobot_chatops/urls.py @@ -1,4 +1,4 @@ -"""Django urlpatterns declaration for nautobot_chatops plugin.""" +"""Django urlpatterns declaration for nautobot_chatops app.""" import logging from django.urls import path diff --git a/nautobot_chatops/views.py b/nautobot_chatops/views.py index 6e980089..b629d4c9 100644 --- a/nautobot_chatops/views.py +++ b/nautobot_chatops/views.py @@ -1,4 +1,4 @@ -"""Views module for the nautobot_chatops Nautobot plugin. +"""Views module for the nautobot_chatops Nautobot App. The views implemented in this module act as endpoints for various chat platforms to send requests and notifications to. diff --git a/nautobot_chatops/workers/__init__.py b/nautobot_chatops/workers/__init__.py index dfe89d59..19bc4322 100644 --- a/nautobot_chatops/workers/__init__.py +++ b/nautobot_chatops/workers/__init__.py @@ -1,4 +1,4 @@ -"""Workers module for the nautobot_chatops Nautobot plugin. +"""Workers module for the nautobot_chatops Nautobot App. The functions in this module provide back-end worker logic that is totally ignorant of the differences between various chat platforms. They receive generic data from @@ -103,7 +103,7 @@ def get_commands_registry(): if _commands_registry[worker.name]["function"] == command_func: logger.warning("Command worker function '%s' was processed twice. This should not happen", worker.name) else: - logger.error("Duplicate worker name '%s' detected! Check for redundant plugins", worker.name) + logger.error("Duplicate worker name '%s' detected! Check for redundant apps", worker.name) continue if worker.name not in _commands_registry: diff --git a/pyproject.toml b/pyproject.toml index 76741f49..df142fc7 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,13 +1,13 @@ [tool.poetry] name = "nautobot-chatops" version = "3.0.1" -description = "A plugin providing chatbot capabilities for Nautobot" +description = "A app providing chatbot capabilities for Nautobot" authors = ["Network to Code, LLC "] license = "Apache-2.0" readme = "README.md" -homepage = "https://github.com/nautobot/nautobot-plugin-chatops/" -repository = "https://github.com/nautobot/nautobot-plugin-chatops/" -keywords = ["nautobot", "nautobot-plugin"] +homepage = "https://github.com/nautobot/nautobot-app-chatops/" +repository = "https://github.com/nautobot/nautobot-app-chatops/" +keywords = ["nautobot", "nautobot-plugin", "nautobot-app"] classifiers = [ "Intended Audience :: Developers", "Development Status :: 5 - Production/Stable", diff --git a/tasks.py b/tasks.py index 73a32283..b2960e11 100644 --- a/tasks.py +++ b/tasks.py @@ -671,7 +671,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_chatops.local): print("Starting Docker Containers...")