Cookie updated by NetworkToCode Cookie Drift Manager Tool (#96)

* Cookie updated by NetworkToCode Cookie Drift Manager Tool Template: ``` { "template": "https://github.com/nautobot/cookiecutter-nautobot-app.git", "dir": "nautobot-app", "ref": "refs/tags/nautobot-app-v2.3.0", "path": null } ``` Cookie: ``` { "remote": "https://github.com/nautobot/nautobot-app-capacity-metrics.git", "path": "/tmp/tmpg67gqfcx/nautobot-app-capacity-metrics", "repository_path": "/tmp/tmpg67gqfcx/nautobot-app-capacity-metrics", "dir": "", "branch_prefix": "drift-manager", "context": { "codeowner_github_usernames": "@nautobot/po-tl-telemetry", "full_name": "Network to Code, LLC", "email": "[email protected]", "github_org": "nautobot", "app_name": "nautobot_capacity_metrics", "verbose_name": "Metrics & Monitoring Extension App", "app_slug": "nautobot-capacity-metrics", "project_slug": "nautobot-app-capacity-metrics", "repo_url": "https://github.com/nautobot/nautobot-app-capacity-metrics", "base_url": "capacity-metrics", "min_nautobot_version": "2.0.0", "max_nautobot_version": "2.9999", "camel_name": "NautobotCapacityMetrics", "project_short_description": "App to improve the instrumentation of Nautobot and expose additional metrics (Application Metrics, RQ Worker).", "model_class_name": "None", "open_source_license": "Apache-2.0", "docs_base_url": "https://docs.nautobot.com", "docs_app_url": "https://docs.nautobot.com/projects/capacity-metrics/en/latest", "_template": "https://github.com/nautobot/cookiecutter-nautobot-app.git", "_output_dir": "/tmp/tmpg67gqfcx", "_repo_dir": "/github/home/.cookiecutters/cookiecutter-nautobot-app/nautobot-app", "_checkout": "refs/tags/nautobot-app-v2.3.0" }, "base_branch": "develop", "remote_name": "origin", "pull_request_strategy": "PullRequestStrategy.CREATE", "post_actions": [ "PostAction.BLACK" ], "baked_commit_ref": "760ec2ce14abd0f7b6608f26be3c6cb170878ff7", "draft": true } ``` CLI Arguments: ``` { "cookie_dir": "", "input": false, "json_filename": "", "output_dir": "", "push": true, "template": "", "template_dir": "", "template_ref": "refs/tags/nautobot-app-v2.3.0", "pull_request": null, "post_action": [], "disable_post_actions": false, "draft": null } ``` * ruff * lockfile * changelog * Update changes/96.housekeeping --------- Co-authored-by: bakebot <[email protected]> Co-authored-by: Gary Snider <[email protected]>
nautobot · Aug 19, 2024 · 7a71809 · 7a71809
1 parent 30af25c
commit 7a71809
Show file tree

Hide file tree

Showing 31 changed files with 210 additions and 293 deletions.
diff --git a/.cookiecutter.json b/.cookiecutter.json
@@ -21,15 +21,15 @@
         "_drift_manager": {
             "template": "https://github.com/nautobot/cookiecutter-nautobot-app.git",
             "template_dir": "nautobot-app",
-            "template_ref": "refs/tags/nautobot-app-v2.2.0",
+            "template_ref": "refs/tags/nautobot-app-v2.3.0",
             "cookie_dir": "",
             "branch_prefix": "drift-manager",
             "pull_request_strategy": "create",
             "post_actions": [
                 "black"
             ],
             "draft": true,
-            "baked_commit_ref": "760ec2ce14abd0f7b6608f26be3c6cb170878ff7"
+            "baked_commit_ref": "b2d4896efd5ed14bb1c0e5a7c3df2cb9fd09b5b0"
         }
     }
 }
diff --git a/.dockerignore b/.dockerignore
@@ -19,7 +19,6 @@ FAQ.md
 .git/
 .gitignore
 .github
-tasks.py
 LICENSE
 **/*.log
 **/.vscode/

diff --git a/.flake8 b/.flake8
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -16,7 +16,7 @@ env:
   APP_NAME: "nautobot-app-capacity-metrics"
 
 jobs:
-  black:
+  ruff-format:
     runs-on: "ubuntu-22.04"
     env:
       INVOKE_NAUTOBOT_CAPACITY_METRICS_LOCAL: "True"
@@ -25,8 +25,8 @@ jobs:
         uses: "actions/checkout@v4"
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
-      - name: "Linting: black"
-        run: "poetry run invoke black"
+      - name: "Linting: ruff format"
+        run: "poetry run invoke ruff --action format"
   bandit:
     runs-on: "ubuntu-22.04"
     env:
@@ -38,7 +38,7 @@ jobs:
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
       - name: "Linting: bandit"
         run: "poetry run invoke bandit"
-  ruff:
+  ruff-lint:
     runs-on: "ubuntu-22.04"
     env:
       INVOKE_NAUTOBOT_CAPACITY_METRICS_LOCAL: "True"
@@ -60,17 +60,6 @@ jobs:
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
       - name: "Check Docs Build"
         run: "poetry run invoke build-and-check-docs"
-  flake8:
-    runs-on: "ubuntu-22.04"
-    env:
-      INVOKE_NAUTOBOT_CAPACITY_METRICS_LOCAL: "True"
-    steps:
-      - name: "Check out repository code"
-        uses: "actions/checkout@v4"
-      - name: "Setup environment"
-        uses: "networktocode/gh-action-setup-poetry-environment@v6"
-      - name: "Linting: flake8"
-        run: "poetry run invoke flake8"
   poetry:
     runs-on: "ubuntu-22.04"
     env:
@@ -96,11 +85,10 @@ jobs:
   check-in-docker:
     needs:
       - "bandit"
-      - "ruff"
-      - "flake8"
+      - "ruff-format"
+      - "ruff-lint"
       - "poetry"
       - "yamllint"
-      - "black"
     runs-on: "ubuntu-22.04"
     strategy:
       fail-fast: true

diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@
   <a href="https://pypi.org/project/nautobot-capacity-metrics/"><img src="https://img.shields.io/pypi/v/nautobot-capacity-metrics"></a>
   <a href="https://pypi.org/project/nautobot-capacity-metrics/"><img src="https://img.shields.io/pypi/dm/nautobot-capacity-metrics"></a>
   <br>
-  An <a href="https://www.networktocode.com/nautobot/apps/">App</a> for <a href="https://nautobot.com/">Nautobot</a> that exposes additional metrics information.
+  An <a href="https://networktocode.com/nautobot-apps/">App</a> for <a href="https://nautobot.com/">Nautobot</a>.
 </p>
 
 ## Metrics Endpoints

diff --git a/changes/96.housekeeping b/changes/96.housekeeping
@@ -0,0 +1 @@
+Rebaked from the cookie `nautobot-app-v2.3.0`.
diff --git a/development/app_config_schema.py b/development/app_config_schema.py
@@ -1,4 +1,5 @@
 """App Config Schema Generator and Validator."""
+
 import json
 from importlib import import_module
 from os import getenv

diff --git a/development/docker-compose.base.yml b/development/docker-compose.base.yml
@@ -13,7 +13,6 @@ x-nautobot-base: &nautobot-base
     - "creds.env"
   tty: true
 
-version: "3.8"
 services:
   nautobot:
     depends_on:

diff --git a/development/docker-compose.dev.yml b/development/docker-compose.dev.yml
@@ -3,7 +3,6 @@
 # any override will need to include these volumes to use them.
 # see:  https://github.com/docker/compose/issues/3729
 ---
-version: "3.8"
 services:
   nautobot:
     command: "nautobot-server runserver 0.0.0.0:8080"

diff --git a/development/docker-compose.mysql.yml b/development/docker-compose.mysql.yml
@@ -1,6 +1,4 @@
 ---
-version: "3.8"
-
 services:
   nautobot:
     environment:
@@ -19,7 +17,6 @@ services:
   db:
     image: "mysql:8"
     command:
-      - "--default-authentication-plugin=mysql_native_password"
       - "--max_connections=1000"
     env_file:
       - "development.env"

diff --git a/development/docker-compose.postgres.yml b/development/docker-compose.postgres.yml
@@ -1,6 +1,4 @@
 ---
-version: "3.8"
-
 services:
   nautobot:
     environment:

diff --git a/development/docker-compose.redis.yml b/development/docker-compose.redis.yml
@@ -1,5 +1,4 @@
 ---
-version: "3.8"
 services:
   redis:
     image: "redis:6-alpine"

diff --git a/development/example_jobs/test_job.py b/development/example_jobs/test_job.py
@@ -1,8 +1,9 @@
 """This script contains an example of a job about users."""
+
 import time
 
 from nautobot.core.celery import register_jobs
-from nautobot.extras.jobs import Job, BooleanVar, IntegerVar
+from nautobot.extras.jobs import BooleanVar, IntegerVar, Job
 
 
 class TestJob(Job):
@@ -17,7 +18,6 @@ def run(self, sleep, fail):
         time.sleep(sleep)
         if fail:
             raise ValueError("I am supposed to fail!")
-        return
 
 
 register_jobs(TestJob)
diff --git a/development/nautobot_config.py b/development/nautobot_config.py
@@ -10,7 +10,7 @@
 # Debug
 #
 
-DEBUG = is_truthy(os.getenv("NAUTOBOT_DEBUG", False))
+DEBUG = is_truthy(os.getenv("NAUTOBOT_DEBUG", "false"))
 _TESTING = len(sys.argv) > 1 and sys.argv[1] == "test"
 
 if DEBUG and not _TESTING:
@@ -48,9 +48,10 @@
         "PASSWORD": os.getenv("NAUTOBOT_DB_PASSWORD", ""),  # Database password
         "HOST": os.getenv("NAUTOBOT_DB_HOST", "localhost"),  # Database server
         "PORT": os.getenv(
-            "NAUTOBOT_DB_PORT", default_db_settings[nautobot_db_engine]["NAUTOBOT_DB_PORT"]
+            "NAUTOBOT_DB_PORT",
+            default_db_settings[nautobot_db_engine]["NAUTOBOT_DB_PORT"],
         ),  # Database port, default to postgres
-        "CONN_MAX_AGE": int(os.getenv("NAUTOBOT_DB_TIMEOUT", 300)),  # Database timeout
+        "CONN_MAX_AGE": int(os.getenv("NAUTOBOT_DB_TIMEOUT", "300")),  # Database timeout
         "ENGINE": nautobot_db_engine,
     }
 }

diff --git a/development/towncrier_template.j2 b/development/towncrier_template.j2
@@ -1,6 +1,6 @@
 
 {% if render_title %}
-## [v{{ versiondata.version }} ({{ versiondata.date }})]({{ cookiecutter.repo_url }}/releases/tag/v{{ versiondata.version}})
+## [v{{ versiondata.version }} ({{ versiondata.date }})](https://github.com/nautobot/nautobot-app-capacity-metrics/releases/tag/v{{ versiondata.version}})
 
 {% endif %}
 {% for section, _ in sections.items() %}

diff --git a/docs/assets/extra.css b/docs/assets/extra.css
@@ -96,7 +96,7 @@ a.autorefs-external:hover::after {
 }
 
 
-/* Customization for mkdocs-version-annotations */
+/* Customization for markdown-version-annotations */
 :root {
     /* Icon for "version-added" admonition: Material Design Icons "plus-box-outline" */
     --md-admonition-icon--version-added: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 19V5H5v14h14m0-16a2 2 0 0 1 2 2v14a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V5a2 2 0 0 1 2-2h14m-8 4h2v4h4v2h-4v4h-2v-4H7v-2h4V7Z"/></svg>');

diff --git a/docs/dev/contributing.md b/docs/dev/contributing.md
@@ -4,7 +4,7 @@ The project is packaged with a light [development environment](dev_environment.m
 
 The project is following Network to Code software development guidelines and is leveraging the following:
 
-- Python linting and formatting: `black`, `pylint`, `bandit`, `flake8`, and `ruff`.
+- Python linting and formatting: `pylint`, `bandit`, and `ruff`.
 - YAML linting is done with `yamllint`.
 - Django unit test to ensure the app is working properly.
 
@@ -47,7 +47,7 @@ The branching policy includes the following tenets:
 - PRs intended to add new features should be sourced from the `develop` branch.
 - PRs intended to fix issues in the Nautobot LTM compatible release should be sourced from the latest `ltm-<major.minor>` branch instead of `develop`.
 
-Metrics & Monitoring Extension App will observe semantic versioning, as of 1.0. This may result in a quick turnaround in minor versions to keep pace with an ever growing feature set.
+Metrics & Monitoring Extension App will observe semantic versioning, as of 1.0. This may result in a quick turnaround in minor versions to keep pace with an ever-growing feature set.
 
 ## Release Policy
 
@@ -56,17 +56,17 @@ Metrics & Monitoring Extension App has currently no intended scheduled release s
 When a new release, from `develop` to `main`, is created the following should happen.
 
 - A release PR is created from `develop` with:
-  - Update the release notes in `docs/admin/release_notes/version_<major>.<minor>.md` file to reflect the changes.
-  - Change the version from `<major>.<minor>.<patch>-beta` to `<major>.<minor>.<patch>` in `pyproject.toml`.
-  - Set the PR to the `main` branch.
+    - Update the release notes in `docs/admin/release_notes/version_<major>.<minor>.md` file to reflect the changes.
+    - Change the version from `<major>.<minor>.<patch>-beta` to `<major>.<minor>.<patch>` in `pyproject.toml`.
+    - Set the PR to the `main` branch.
 - Ensure the tests for the PR pass.
 - Merge the PR.
 - Create a new tag:
-  - The tag should be in the form of `v<major>.<minor>.<patch>`.
-  - The title should be in the form of `v<major>.<minor>.<patch>`.
-  - The description should be the changes that were added to the `version_<major>.<minor>.md` document.
+    - The tag should be in the form of `v<major>.<minor>.<patch>`.
+    - The title should be in the form of `v<major>.<minor>.<patch>`.
+    - The description should be the changes that were added to the `version_<major>.<minor>.md` document.
 - If merged into `main`, then push from `main` to `develop`, in order to retain the merge commit created when the PR was merged
 - A post release PR is created with:
-  - Change the version from `<major>.<minor>.<patch>` to `<major>.<minor>.<patch + 1>-beta` in both `pyproject.toml` and `nautobot.__init__.__version__`.
-  - Set the PR to the proper branch, `develop`.
-  - Once tests pass, merge.
+    - Change the version from `<major>.<minor>.<patch>` to `<major>.<minor>.<patch + 1>-beta` in both `pyproject.toml` and `nautobot.__init__.__version__`.
+    - Set the PR to the proper branch, `develop`.
+    - Once tests pass, merge.
diff --git a/docs/dev/dev_environment.md b/docs/dev/dev_environment.md
@@ -124,9 +124,7 @@ Each command can be executed with `invoke <command>`. All commands support the a
 
 ```
   bandit           Run bandit to validate basic static code security analysis.
-  black            Run black to check that Python files adhere to its style standards.
-  flake8           Run flake8 to check that Python files adhere to its style standards.
-  ruff             Run ruff to validate docstring formatting adheres to NTC defined standards.
+  ruff             Run ruff to perform code formatting and/or linting.
   pylint           Run pylint code analysis.
   tests            Run all tests for this app.
   unittest         Run Django unit tests for the app.
@@ -454,7 +452,7 @@ This is the same as running:
 
 ### Tests
 
-To run tests against your code, you can run all of the tests that TravisCI runs against any new PR with:
+To run tests against your code, you can run all of the tests that the CI runs against any new PR with:
 
 ```bash
 ➜ invoke tests
@@ -465,8 +463,6 @@ To run an individual test, you can run any or all of the following:
 ```bash
 ➜ invoke unittest
 ➜ invoke bandit
-➜ invoke black
-➜ invoke flake8
 ➜ invoke ruff
 ➜ invoke pylint
 ```

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,5 +1,5 @@
 mkdocs==1.5.2
 mkdocs-material==9.1.15
-mkdocs-version-annotations==1.0.0
+markdown-version-annotations==1.0.1
 mkdocstrings-python==1.5.2
 mkdocstrings==0.22.0
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -72,6 +72,8 @@ extra:
       link: "https://twitter.com/networktocode"
       name: "Network to Code Twitter"
 markdown_extensions:
+  - "markdown_version_annotations":
+      admonition_tag: "???"
   - "admonition"
   - "toc":
       permalink: true
@@ -89,7 +91,6 @@ markdown_extensions:
   - "footnotes"
 plugins:
   - "search"
-  - "mkdocs-version-annotations"
   - "mkdocstrings":
       default_handler: "python"
       handlers:

diff --git a/nautobot_capacity_metrics/api/urls.py b/nautobot_capacity_metrics/api/urls.py
@@ -1,5 +1,7 @@
 """Django URL patterns for nautobot_capacity_metrics app."""
+
 from django.urls import path
+
 from . import views
 
 urlpatterns = [

diff --git a/nautobot_capacity_metrics/api/views.py b/nautobot_capacity_metrics/api/views.py
@@ -1,11 +1,11 @@
 """Django views for Prometheus metric collection and reporting."""  # pylint:  disable=too-few-public-methods
-import time
+
 import logging
+import time
 
+import prometheus_client
 from django.conf import settings
 from django.http import HttpResponse
-
-import prometheus_client
 from prometheus_client.core import CollectorRegistry, GaugeMetricFamily
 
 from nautobot_capacity_metrics import __REGISTRY__

diff --git a/nautobot_capacity_metrics/metrics.py b/nautobot_capacity_metrics/metrics.py
@@ -1,18 +1,16 @@
 """Metrics libraries for the nautobot_capacity_metrics app."""
-import logging
+
 import importlib
+import logging
 import platform
 from collections.abc import Iterable
 from copy import deepcopy
 
 import django
-from packaging import version
 from django.conf import settings
-
-from prometheus_client.core import Metric, GaugeMetricFamily
-
 from nautobot.extras.choices import JobResultStatusChoices
-
+from packaging import version
+from prometheus_client.core import GaugeMetricFamily, Metric
 
 logger = logging.getLogger(__name__)
 

diff --git a/nautobot_capacity_metrics/test_models/migrations/0001_initial.py b/nautobot_capacity_metrics/test_models/migrations/0001_initial.py
@@ -1,8 +1,9 @@
 # Generated by Django 3.2.16 on 2022-12-20 13:24
 
-from django.db import migrations, models
 import uuid
 
+from django.db import migrations, models
+
 
 class Migration(migrations.Migration):
     initial = True