Version 1.5.1 (#119)

* New Example06 - IP Prefixes (#111)

* first draft of example06

Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>

* Attempt to fix the read the docs pipeline. (#115)

* Attempt to fix the read the docs pipeline.

* Yamllint.

Co-authored-by: Leo Kirchner <leo@kirchne.red>

* Update CODEOWNERS (#113)

* Fix get() by modelname (#118)

* Update example05 (#107)

* Update example05

* Use site as children

* Add update after adding children

* Add pylint disable until Redis code is in

* Update example

* simplify

* wip

* wip

* Update example

* Take redis from main

* imprort order

* yml

* update readme

* Use diffsync from pypi

* Apply suggestions from code review

Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>

* Code review

* replace bash by python exec

* Rename dockerfile to Dockerfile

* Update docs source

Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>

* Update CHANGELOG and bump version

Co-authored-by: Christian Adell <chadell@gmail.com>
Co-authored-by: Leo Kirchner <Kircheneer@users.noreply.github.com>
Co-authored-by: Leo Kirchner <leo@kirchne.red>

Author: 3 people

.github/CODEOWNERS

@@ -1,2 +1,2 @@
 # Default owners for all files in this repository
-* @glennmatthews @dgarros
+* @glennmatthews @Kircheneer @chadell

.gitignore

@@ -289,3 +289,6 @@ fabric.properties
 
 ## Sphinx Documentation ##
 docs/build
+
+## Secrets
+creds.env

.readthedocs.yml

@@ -7,9 +7,6 @@ sphinx:
   fail_on_warning: false
 
 python:
-  version: 3.7
+  version: "3.7"
   install:
-    - method: "pip"
-      path: "."
-      extra_requirements:
-        - "docs"
+    - requirements: "docs/requirements.txt"

CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## v1.5.1 - 2022-06-30
+
+### Added
+
+- #111 - Added example 6, regarding IP prefixes.
+
+### Changed
+
+- #107 - Updated example 5 to use the Redis backend store.
+
+### Fixed
+
+- #115 - Fixed ReadTheDocs rendering pipeline
+- #118 - Fixed a regression in `DiffSync.get(modelname, identifiers)` introduced in 1.5.0
+
 ## v1.5.0 - 2022-06-07
 
 ### Added

diffsync/store/__init__.py

@@ -194,9 +194,9 @@ def _get_object_class_and_model(
         """Get object class and model name for a model."""
         if isinstance(model, str):
             modelname = model
-            if not hasattr(self, model):
+            if not hasattr(self.diffsync, model):
                 return None, modelname
-            object_class = getattr(self, model)
+            object_class = getattr(self.diffsync, model)
         else:
             object_class = model
             modelname = model.get_type()
@@ -216,7 +216,7 @@ def _get_uid(
             uid = object_class.create_unique_id(**identifier)
         else:
             raise ValueError(
-                f"Invalid args: ({model}, {identifier}): "
-                f"either {model} should be a class/instance or {identifier} should be a str"
+                f"Invalid args: ({model}, {object_class}, {identifier}): "
+                f"either {object_class} should be a class/instance or {identifier} should be a str"
             )
         return uid

docs/requirements.txt

@@ -0,0 +1,5 @@
+m2r2==0.2.7
+mistune==0.8.4
+sphinx==4.5.0
+toml==0.10.2
+sphinx-rtd-theme==1.0.0

docs/source/api/diffsync.rst

@@ -16,3 +16,11 @@ API Reference
    diffsync.helpers
    diffsync.logging
    diffsync.utils
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   diffsync.store

docs/source/api/diffsync.store.local.rst

@@ -0,0 +1,7 @@
+diffsync.store.local
+====================
+
+.. automodule:: diffsync.store.local
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/api/diffsync.store.redis.rst

@@ -0,0 +1,7 @@
+diffsync.store.redis
+====================
+
+.. automodule:: diffsync.store.redis
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/api/diffsync.store.rst

@@ -0,0 +1,14 @@
+API Reference
+=============
+
+.. automodule:: diffsync.store
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. toctree::
+   :maxdepth: 4
+
+   diffsync.store.local
+   diffsync.store.redis