Merge pull request #307 from jvanderaa/add_doc_arch

Updates doc with arch diagram

.github/workflows/ci.yml

@@ -128,7 +128,7 @@ jobs:
     runs-on: "ubuntu-20.04"
     strategy:
       matrix:
-        nautobot-version: ["1.2.12", "1.3.6", "1.4.10", "latest"]
+        nautobot-version: ["1.2.12", "1.3.6", "1.4.10", "1.5.18", "latest"]
     steps:
       - name: "Check out repository code"
         uses: "actions/checkout@v2"

.gitignore

@@ -3,6 +3,9 @@ network_importer.egg-info
 *.zip
 *.log
 
+# Default config backup folder
+configs/
+
 ### Python ###
 # Byte-compiled / optimized / DLL files
 __pycache__/

README.md

@@ -7,6 +7,10 @@ The main use cases for the network importer:
 - Import an existing network into a SOT (Nautobot or NetBox) as a first step to automate a brownfield network
 - Check the differences between the running network and the Source of Truth
 
+This application is intended to run __outside__ of Nautobot. 
+
+![Architecture](docs/images/batfish_network_importer.png)
+
 ## Quick Start
 
 - [Getting Started](docs/getting_started.md)

network_importer/adapters/nautobot_api/models.py

@@ -50,8 +50,8 @@ def get_device_tag_id(self):
         tag = self.diffsync.nautobot.extras.tags.get(name=f"device={self.name}")
         if not tag:
             tag = self.diffsync.nautobot.extras.tags.create(
-                name=f"device={self.name}",
-                slug=f"device__{''.join(c if c.isalnum() else '_' for c in self.name)}")
+                name=f"device={self.name}", slug=f"device__{''.join(c if c.isalnum() else '_' for c in self.name)}"
+            )
 
         self.device_tag_id = tag.id
         return self.device_tag_id