add readme, fix lint, update pkgs

Author: FloSch62

docs/clab2drawio.md

@@ -141,6 +141,22 @@ The easiest way to create perfect layouts is using the VS Code Containerlab exte
      clab2drawio -i <path_to_your_yaml_file> -g --theme grafana --grafana-config <path_to_your_cfg_file>
      ```
 
+- `--grafana-interface-format`: Maps interface names for Grafana export using regex patterns. This allows you to transform interface names to match your monitoring system's naming conventions.
+
+     ```bash
+     clab2drawio -i <path_to_your_yaml_file> -g --grafana-interface-format "e1-{x}:ethernet1/{x}"
+     ```
+
+     This would convert interface names like `e1-1` to `ethernet1/1` in the Grafana dashboard.
+
+- `--grafana-interface-selector`: Selects which part of the interface name to display as the port label using regex patterns with capture groups.
+
+     ```bash
+     clab2drawio -i <path_to_your_yaml_file> -g --grafana-interface-selector "e1-1-c{x}-1"
+     ```
+
+     This would extract and display only the captured digit (e.g., from `e1-1-c3-1` it would display `3` as the port label).
+
     For more detailed information about this feature, including compatibility, usage guidelines, and future enhancements, please see the [Grafana Dashboard Documentation](./grafana.md).
 
 - `--include-unlinked-nodes`: Include nodes without any links in the topology diagram. By default, only nodes with at least one connection are included.

docs/grafana.md

@@ -58,6 +58,32 @@ clab2drawio -i <path_to_yaml> -g --theme grafana --grafana-config <path_to_confi
 > [!TIP]  
 > Customize targets, thresholds, or labels in your YAML to align with your network's metrics and visualization needs.
 
+#### Interface Name Mapping
+
+The `--grafana-interface-format` option allows you to transform interface names to match your monitoring system's naming conventions. This is useful when your containerlab topology uses different interface naming than your telemetry system.
+
+Example:
+```bash
+clab2drawio -i topo.yml -g --grafana-interface-format "e1-{x}:ethernet1/{x}"
+```
+
+This would map interface names like:
+- `e1-1` → `ethernet1/1`
+- `e1-48` → `ethernet1/48`
+
+#### Interface Label Selection
+
+The `--grafana-interface-selector` option lets you control which part of complex interface names appears as port labels in the diagram. This is useful for cleaner visualization when interface names contain multiple segments.
+
+Example:
+```bash
+clab2drawio -i topo.yml -g --grafana-interface-selector "e1-1-c{x}-1"
+```
+
+This would extract and display only the captured digit from interface names like:
+- `e1-1-c3-1` → displays `3` as the port label
+- `e1-1-c10-1` → displays `10` as the port label
+
 #### To export the diagram as an SVG:
 To get a full guide: [https://github.com/andymchugh/andrewbmchugh-flow-panel/blob/main/src/README.md#using-drawio-to-create-your-svg](https://github.com/andymchugh/andrewbmchugh-flow-panel/blob/main/src/README.md#using-drawio-to-create-your-svg)
 

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "clab-io-draw"
-version = "0.6.2"
+version = "0.6.3"
 description = "Convert between draw.io and containerlab topology files"
 readme = "README.md"
 requires-python = ">=3.11"
@@ -10,12 +10,12 @@ dependencies = [
     "PyYAML==6.0.2",
     "six==1.17.0",
     "wcwidth==0.2.13",
-    "ruamel-yaml==0.18.14",
+    "ruamel-yaml==0.18.15",
     "textual-dev==1.7.0",
     "textual==5.3.0",
     "networkx>=3.5.0",
     "defusedxml>=0.7.1",
-    "typer>=0.16.0",
+    "typer>=0.16.1",
     "pytest>=8.4.1",
 ]
 
@@ -75,5 +75,5 @@ docstring-code-line-length = "dynamic"
 [dependency-groups]
 dev = [
     "pre-commit>=4.2.0",
-    "ruff>=0.11.13",
+    "ruff>=0.12.10",
 ]

src/clab_io_draw/clab2drawio.py

@@ -270,7 +270,7 @@ def main(
 
     if grafana:
         styles["ports"] = True
-    
+
     if grafana_interface_selector:
         styles["grafana_interface_selector"] = grafana_interface_selector
 

src/clab_io_draw/core/diagram/diagram_builder.py

@@ -15,15 +15,15 @@ def get_intf_digit(self, intf_name, styles):
         interface_selector = styles.get("grafana_interface_selector")
         if interface_selector:
             regex_pattern = interface_selector.replace("{x}", r"(\d+)")
-            
+
             try:
                 match = re.match(f"^{regex_pattern}$", intf_name)
                 if match:
                     return match.group(1)
             except re.error as e:
                 logger.warning(f"Invalid pattern for grafana_interface_selector: {e}")
 
-        # fallback to default        
+        # fallback to default
         digits = re.findall(r"\d+", intf_name)
         return digits[-1] if digits else "0"