Update from PR and remove example5 from test

Author: chadell

examples/05-nautobot-peeringdb/README.md

@@ -24,13 +24,15 @@ source .venv/bin/activate
 pip3 install -r requirements.txt
 ```
 
-## Run it interactivelly
+## Run it interactively
 
 ```python
 from IPython import embed
 embed(colors="neutral")
 
-# Import Adapaters
+# Import Adapters
+from diffsync.enum import DiffSyncFlags
+
 from adapter_nautobot import NautobotRemote
 from adapter_peeringdb import PeeringDB
 
@@ -59,5 +61,6 @@ diff = nautobot.diff_from(peeringdb)
 diff.summary()
 
 # Execute the synchronization
-nautobot.sync_from(peeringdb)
+nautobot.sync_from(peeringdb, flags=DiffSyncFlags.SKIP_UNMATCHED_DST)
+
 ```

examples/05-nautobot-peeringdb/adapter_nautobot.py

@@ -160,7 +160,6 @@ def load(self):
                 pk=region_entry["id"],
             )
             self.add(region)
-            # self.job.log_debug(message=f"Loaded {region} from remote Nautobot instance")
 
         site_data = requests.get(f"{self.url}/api/dcim/sites/", headers=self.headers, params={"limit": 0}).json()
         sites = site_data["results"]
@@ -180,7 +179,6 @@ def load(self):
                 pk=site_entry["id"],
             )
             self.add(site)
-            # self.job.log_debug(message=f"Loaded {site} from remote Nautobot instance")
 
     def post(self, path, data):
         """Send an appropriately constructed HTTP POST request."""

examples/05-nautobot-peeringdb/adapter_peeringdb.py

@@ -35,8 +35,9 @@ def load(self):
             try:
                 self.get(self.region, fac["city"])
             except ObjectNotFound:
-                # Adding the parent region if necessary
+                # Use pycountry to translate the country code (like "DE") to a country name (like "Germany")
                 parent_name = pycountry.countries.get(alpha_2=fac["country"]).name
+                # Add the country as a parent region if not already added
                 try:
                     self.get(self.region, parent_name)
                 except ObjectNotFound:

examples/05-nautobot-peeringdb/main.py

@@ -0,0 +1,29 @@
+# Import Adapters
+from diffsync.enum import DiffSyncFlags
+
+from adapter_nautobot import NautobotRemote
+from adapter_peeringdb import PeeringDB
+
+# Initialize PeeringDB adapter, using CATNIX id for demonstration
+peeringdb = PeeringDB(ix_id=62)
+
+# Initialize Nautobot adapter, pointing to the demo instance (it's also the default settings)
+nautobot = NautobotRemote(url="https://demo.nautobot.com", token="aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
+
+# Load PeeringDB info into the adapter
+peeringdb.load()
+
+# We can check the data that has been imported, some as `site` and some as `region` (with the parent relationships)
+peeringdb.dict()
+
+# Load Nautobot info into the adapter
+nautobot.load()
+
+# Let's diffsync do it's magic
+diff = nautobot.diff_from(peeringdb)
+
+# Quick summary of the expected changes (remember that delete ones are dry-run)
+diff.summary()
+
+# Execute the synchronization
+nautobot.sync_from(peeringdb, flags=DiffSyncFlags.SKIP_UNMATCHED_DST)

tests/unit/test_examples.py

@@ -43,11 +43,3 @@ def test_example_4():
     example4_main = join(example4_dir, "main.py")
     # Run it and make sure it doesn't raise an exception or otherwise exit with a non-zero code.
     subprocess.run(example4_main, cwd=example4_dir, check=True)
-
-
-def test_example_5():
-    """Test that the "example5" script runs successfully."""
-    example5_dir = join(EXAMPLES, "05-nautobot-peeringdb")
-    example5_main = join(example5_dir, "main.py")
-    # Run it and make sure it doesn't raise an exception or otherwise exit with a non-zero code.
-    subprocess.run(example5_main, cwd=example5_dir, check=True)