Update library import / small refactor

.envrc

@@ -0,0 +1,28 @@
+# direnv configuration 
+# Run `direnv allow` to enable
+
+# Source .env file if it exists (contains secrets, not in git)
+if [[ -f .env ]]; then
+    log_status "Loading .env variables..."
+    dotenv .env
+fi
+
+# Create and activate uv virtual environment
+if command -v uv &> /dev/null; then
+    # Create venv if it doesn't exist
+    if [[ ! -d .venv ]]; then
+        log_status "Creating virtual environment with uv..."
+        uv venv .venv
+    fi
+
+    # Sync dependencies
+    if [[ -f pyproject.toml ]]; then
+        log_status "Syncing dependencies with uv..."
+        uv sync --quiet --native-tls
+    fi
+
+    # Activate the virtual environment
+    source .venv/bin/activate
+else
+    log_error "uv not found. Please install uv: https://docs.astral.sh/uv/"
+fi

.github/dependabot.yml

@@ -9,3 +9,7 @@ updates:
     directory: "/"
     schedule:
       interval: "weekly"
+  - package-ecosystem: "uv"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/docker.yml

@@ -18,6 +18,10 @@ on:
   release:
     types: [published, edited]
 
+concurrency:
+  group: docker-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   build-and-push-images:
     runs-on: ubuntu-latest

.github/workflows/tests.yml

@@ -1,5 +1,8 @@
 name: tests
 
+permissions:
+  contents: read
+
 on:
   push:
     branches:
@@ -36,4 +39,4 @@ jobs:
         run: uv run ruff check .
 
       - name: Check formatting
-        run: uv run black --check .
+        run: uv run ruff format --check .

.gitignore

@@ -104,6 +104,7 @@ celerybeat.pid
 # Environments
 .env*
 !.env.example
+!.envrc
 .venv
 env/
 venv/

.markdownlint.json

@@ -0,0 +1,5 @@
+{
+  "MD013": {
+    "line_length": 120
+  }
+}

.pre-commit-config.yaml

@@ -1,4 +1,8 @@
 repos:
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.47.0
+    hooks:
+      - id: markdownlint
   - repo: local
     hooks:
       - id: ruff
@@ -7,9 +11,9 @@ repos:
         language: system
         types: [python]
         require_serial: true
-      - id: black
-        name: black
-        entry: uv run black
+      - id: ruff-format
+        name: ruff-format
+        entry: uv run ruff format
         language: system
         types: [python]
         require_serial: true

README.md

@@ -1,112 +1,153 @@
-# Netbox Device Type Import
+# NetBox Device Type Import
 
-This library is intended to be your friend and help you import all the device-types defined within the the [NetBox Device Type Library Repository](https://github.com/netbox-community/devicetype-library).
+This library is intended to be your friend and help you import all the device-types defined within
+the [NetBox Device Type Library Repository](https://github.com/netbox-community/devicetype-library).
 
 > Tested working with 2.9.4, 2.10.4
 
-## 🪄 Description
+## Description
 
-This script will clone a copy of the `netbox-community/devicetype-library` repository to your machine to allow it to import the device types you would like without copy and pasting them into the Netbox UI.
+This script will clone a copy of the `netbox-community/devicetype-library` repository to your
+machine to allow it to import the device types you would like without copy and pasting them
+into the NetBox UI.
 
-## 🚀 Getting Started
+## Getting Started
 
-3. This script uses `uv` for dependency management.
+1. This script uses `uv` for dependency management.
 
-```
-uv sync
-```
+   ```shell
+   uv sync
+   ```
 
-4. There are two variables that are required when using this script to import device types into your NetBox installation. (1) Your Netbox instance URL and (2) a token with **write rights**.
+1. There are two variables that are required when using this script to import device types
+   into your NetBox installation. (1) Your NetBox instance URL and (2) a token with
+   **write rights**.
 
 Copy the existing `.env.example` to your own `.env` file, and fill in the variables.
 
-```
+```shell
 cp .env.example .env
 vim .env
 ```
 
 Finally, we are able to execute the script and import some device templates!
 
-## 🔌 Usage
+## Usage
 
-To use the script, simply execute the script as follows. `uv` will handle the virtual environment.
+To use the script, simply execute the script as follows. `uv` will handle the virtual
+environment.
 
-```
+```shell
 uv run nb-dt-import.py
 ```
 
-Copy the existing `.env.example` to your own `.env` file, and fill in the variables.
+This will clone the latest master branch from the `netbox-community/devicetype-library`
+from GitHub and install it into the `repo` subdirectory. If this directory already exists,
+it will perform a `git pull` to update the repository instead.
 
-```
-cp .env.example .env
-vim .env
-```
+Next, it will loop over every manufacturer and every device of every manufacturer and begin
+checking if your NetBox install already has them, and if not, creates them. It will skip
+preexisting manufacturers, devices, interfaces, etc. so as to not end up with duplicate
+entries in your NetBox instance.
 
-Finally, we are able to execute the script and import some device templates!
+### Arguments
 
-## 🔌 Usage
+This script currently accepts a list of vendors as an argument, so that you can selectively
+import devices.
 
-To use the script, simply execute the script as follows. Make sure you're still in the activated virtual environment we created before.
+To import only device by APC, for example:
 
+```shell
+./nb-dt-import.py --vendors apc
 ```
-./nb-dt-import.py
+
+`--vendors` can also accept a comma-separated list of vendors if you want to import multiple.
+
+```shell
+./nb-dt-import.py --vendors apc,juniper
 ```
 
-This will clone the latest master branch from the `netbox-community/devicetype-library` from Github and install it into the `repo` subdirectory. If this directory already exists, it will perform a `git pull` to update the repository instead.
+#### Update Mode
 
-Next, it will loop over every manufacturer and every device of every manufacturer and begin checking if your Netbox install already has them, and if not, creates them. It will skip preexisting manufacturers, devices, interfaces, etc. so as to not end up with duplicate entries in your Netbox instance.
+By default, the script only creates new device types and skips existing ones. To update
+existing device types:
 
-### 🧰 Arguments
+```shell
+./nb-dt-import.py --update
+```
 
-This script currently accepts a list of vendors as an argument, so that you can selectively import devices.
+This will:
 
-To import only device by APC, for example:
+- Add new components (interfaces, power ports, etc.) that are in YAML but missing from NetBox
+- Update properties of existing components if they've changed
+- Update device type properties (u_height, part_number, etc.) if they've changed
+- **Report** components that exist in NetBox but are missing from YAML (won't delete by default)
 
-```
-./nb-dt-import.py --vendors apc
-```
+#### Component Removal (Use with Caution)
 
-`--vendors` can also accept a comma separated list of vendors if you want to import multiple.
+> **WARNING**: Removing components can affect existing device instances in NetBox.
 
+If you've changed a device type definition (for example, converting interfaces to module-bays
+to support SFP modules), you can remove obsolete components with:
+
+```shell
+./nb-dt-import.py --update --remove-components
 ```
-./nb-dt-import.py --vendors apc,juniper
-```
+
+This will delete any components (interfaces, ports, bays, etc.) that exist in NetBox but are
+no longer present in the YAML definition.
+
+**Use cases**:
+
+- Converting fixed interfaces to module-bays for modular devices
+- Removing incorrectly defined components from device templates
+- Cleaning up after major device type definition changes
+
+**Important considerations**:
+
+- Components attached to actual device instances may prevent deletion
+- Review the change detection report before enabling component removal
+- Test on a staging NetBox instance first if possible
 
 ## Docker build
 
 It's possible to use this project as a docker container.
 
-To build :
+To build:
 
-```
+```shell
 docker build -t netbox-devicetype-import-library .
 ```
 
-Alternatively you can pull a pre-built image from Github Container Registry (ghcr.io):
+Alternatively you can pull a pre-built image from GitHub Container Registry (ghcr.io):
 
-```
+```shell
 docker pull ghcr.io/minitriga/netbox-device-type-library-import
 ```
 
-The container supports the following env var as configuration :
+The container supports the following env var as configuration:
 
-- `REPO_URL`, the repo to look for device types (defaults to _https://github.com/netbox-community/devicetype-library.git_)
+- `REPO_URL`, the repo to look for device types
+  (defaults to `https://github.com/netbox-community/devicetype-library.git`)
 - `REPO_BRANCH`, the branch to check out if appropriate, defaults to master.
 - `NETBOX_URL`, used to access netbox
 - `NETBOX_TOKEN`, token for accessing netbox
 - `VENDORS`, a comma-separated list of vendors to import (defaults to None)
-- `REQUESTS_CA_BUNDLE`, path to a CA_BUNDLE for validation if you are using self-signed certificates(file must be included in the container)
+- `REQUESTS_CA_BUNDLE`, path to a CA_BUNDLE for validation if you are using
+  self-signed certificates (file must be included in the container)
 
-To run :
+To run:
 
-```
-docker run -e "NETBOX_URL=http://netbox:8080/" -e "NETBOX_TOKEN=98765434567890" ghcr.io/minitriga/netbox-device-type-library-import
+```shell
+docker run -e "NETBOX_URL=http://netbox:8080/" \
+  -e "NETBOX_TOKEN=98765434567890" \
+  ghcr.io/minitriga/netbox-device-type-library-import
 ```
 
-## 🧑‍💻 Contributing
+## Contributing
 
 We're happy about any pull requests!
 
-## 📜 License
+## License
 
 MIT