Update to support py312 and tooling to current standard (#88)

Removed upper bound on Python version. Added upper bound on pylint version (due to #89). Switched tooling to ruff as per changes to the Nautobot App Template and removed flake8, pydocstyle, and bandit. --------- Co-authored-by: Gary Snider <[email protected]>
nautobot · Aug 22, 2024 · c03b810 · c03b810
1 parent 27355d1
commit c03b810
Show file tree

Hide file tree

Showing 29 changed files with 681 additions and 796 deletions.
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: "pylint-nautobot"
 
 jobs:
-  black:
+  ruff-format:
     runs-on: "ubuntu-latest"
     env:
       INVOKE_PYLINT_NAUTOBOT_LOCAL: "True"
@@ -25,20 +25,9 @@ jobs:
         uses: "actions/checkout@v4"
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
-      - name: "Linting: black"
-        run: "poetry run invoke black"
-  bandit:
-    runs-on: "ubuntu-latest"
-    env:
-      INVOKE_PYLINT_NAUTOBOT_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: bandit"
-        run: "poetry run invoke bandit"
-  ruff:
+      - name: "Linting: ruff format"
+        run: "poetry run invoke ruff --action format"
+  ruff-lint:
     runs-on: "ubuntu-latest"
     env:
       INVOKE_PYLINT_NAUTOBOT_LOCAL: "True"
@@ -60,17 +49,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-latest"
-    env:
-      INVOKE_PYLINT_NAUTOBOT_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-latest"
     env:
@@ -95,16 +73,15 @@ jobs:
         run: "poetry run invoke yamllint"
   pylint:
     needs:
-      - "bandit"
-      - "ruff"
-      - "flake8"
       - "poetry"
       - "yamllint"
-      - "black"
+      - "ruff-format"
+      - "ruff-lint"
     runs-on: "ubuntu-latest"
     strategy:
       fail-fast: true
       matrix:
+        # TODO: Update to 3.12 once #89 is implemented
         python-version: ["3.11"]
         nautobot-version: ["stable"]
     env:
@@ -141,10 +118,14 @@ jobs:
       fail-fast: true
       matrix:
         python-version: ["3.11"]
-        nautobot-version: ["1.6", "2.0", "2.1"]
+        # Incompatible with 2.2.3-2.3.0 due to https://github.com/nautobot/nautobot/pull/6116
+        nautobot-version: ["1.6", "2.0", "2.1", "2.2.2", "2.3"]
         include:
           - python-version: "3.8"
-            nautobot-version: "2.1"
+            nautobot-version: "stable"
+          # TODO: Enable once #89 is implemented and remove 2.3 from matrix
+          # - python-version: "3.12"
+          #   nautobot-version: "stable"
     runs-on: "ubuntu-latest"
     env:
       INVOKE_PYLINT_NAUTOBOT_PYTHON_VER: "${{ matrix.python-version }}"

diff --git a/.gitignore b/.gitignore
@@ -306,3 +306,7 @@ invoke.yml
 public
 /compose.yaml
 /pylint-nautobot/static/nautobot_firewall_models/docs
+
+# Vagrant
+.vagrant
+Vagrantfile
diff --git a/development/docker-compose.base.yml b/development/docker-compose.base.yml
@@ -10,7 +10,6 @@ x-nautobot-base: &nautobot-base
   image: "pylint-nautobot/nautobot:${NAUTOBOT_VER}-py${PYTHON_VER}"
   tty: true
 
-version: "3.8"
 services:
   nautobot:
     <<:

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:
     volumes:

diff --git a/development/nautobot_config.py b/development/nautobot_config.py
@@ -1,2 +1,5 @@
 """Nautobot development configuration file."""
-SECRET_KEY = "NOTASECRET"  # nosec
+
+from nautobot.core.settings import *  # noqa: F403  # pylint: disable=wildcard-import,unused-wildcard-import
+
+SECRET_KEY = "NOTASECRET"  # noqa: S105
diff --git a/docs/development.md b/docs/development.md
@@ -10,7 +10,7 @@ The project is packaged with a light development environment using `invoke` task
 
 The project is following Network to Code software development guidelines and is leveraging the following:
 
-- Python linting and formatting: `black`, `pylint`, `bandit`, `flake8`, and `pydocstyle`.
+- Python linting and formatting: `pylint` and `ruff` (which includes rules from `bandit`, `flake8`, and `pydocstyle`).
 - YAML linting is done with `yamllint`.
 - Python unit tests to ensure the rules are working properly.
 

diff --git a/docs/release_notes.md b/docs/release_notes.md
@@ -12,12 +12,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [0.3.0] - 2024-03-05
 
-### Added 
+### Added
 
 - Added `nb-use-fields-all` rule (#70)
 - Added `nautobot-sub-class-name` rule (#74)
 
-### Changed 
+### Changed
 
 - Improve incorrect base class checker (#72)
 - Update CODEOWNERS (#68)