diffsync 2.0.0__tar.gz → 2.0.1__tar.gz

{diffsync-2.0.0 → diffsync-2.0.1}/CHANGELOG.md

@@ -4,6 +4,21 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
+## [2.0.1]
+
+### Changed
+
+- #276 - Removed upper version boud for `structlog` dependency
+
+### Fixed
+
+- #281 - Properly deprecated `DiffSync` class name
+- #273 - Properly capitalized `DiffSync` in documentation
+- #273 - Removed more mentions of `DiffSync` in favor of `Adapter`
+- #274 - Fixed doc section title for getting started
+- #269 - Fixed wording for a couple of docstrings
+- #265 - Fixed readthedocs build
+
 ## [2.0.0]
 
 ### Changed

{diffsync-2.0.0 → diffsync-2.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: diffsync
-Version: 2.0.0
+Version: 2.0.1
 Summary: Library to easily sync/diff/update 2 different data sources
 Home-page: https://diffsync.readthedocs.io
 License: Apache-2.0
@@ -15,12 +15,13 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Provides-Extra: redis
 Requires-Dist: colorama (>=0.4.3,<0.5.0)
 Requires-Dist: packaging (>=21.3,<24.0)
 Requires-Dist: pydantic (>=2.0.0,<3.0.0)
 Requires-Dist: redis (>=4.3,<5.0) ; extra == "redis"
-Requires-Dist: structlog (>=20.1.0,<23.0.0)
+Requires-Dist: structlog (>=20.1.0)
 Requires-Dist: typing-extensions (>=4.0.1) ; python_version < "3.11"
 Project-URL: Documentation, https://diffsync.readthedocs.io
 Project-URL: Repository, https://github.com/networktocode/diffsync
@@ -45,16 +46,16 @@ DiffSync is at its most useful when you have multiple sources or sets of data to
 
 DiffSync acts as an intermediate translation layer between all of the data sets you are diffing and/or syncing. In practical terms, this means that to use DiffSync, you will define a set of data models as well as the “adapters” needed to translate between each base data source and the data model. In Python terms, the adapters will be subclasses of the `Adapter` class, and each data model class will be a subclass of the `DiffSyncModel` class.
 
-![Diffsync Components](https://raw.githubusercontent.com/networktocode/diffsync/develop/docs/images/diffsync_components.png "Diffsync Components")
+![DiffSync Components](https://raw.githubusercontent.com/networktocode/diffsync/develop/docs/images/diffsync_components.png "DiffSync Components")
 
 
 Once you have used each adapter to load each data source into a collection of data model records, you can then ask DiffSync to “diff” the two data sets, and it will produce a structured representation of the difference between them. In Python, this is accomplished by calling the `diff_to()` or `diff_from()` method on one adapter and passing the other adapter as a parameter.
 
-![Diffsync Diff Creation](https://raw.githubusercontent.com/networktocode/diffsync/develop/docs/images/diffsync_diff_creation.png "Diffsync Diff Creation")
+![DiffSync Diff Creation](https://raw.githubusercontent.com/networktocode/diffsync/develop/docs/images/diffsync_diff_creation.png "DiffSync Diff Creation")
 
 You can also ask DiffSync to “sync” one data set onto the other, and it will instruct your adapter as to the steps it needs to take to make sure that its data set accurately reflects the other. In Python, this is accomplished by calling the `sync_to()` or `sync_from()` method on one adapter and passing the other adapter as a parameter.
 
-![Diffsync Sync](https://raw.githubusercontent.com/networktocode/diffsync/develop/docs/images/diffsync_sync.png "Diffsync Sync")
+![DiffSync Sync](https://raw.githubusercontent.com/networktocode/diffsync/develop/docs/images/diffsync_sync.png "DiffSync Sync")
 
 # Simple Example
 

{diffsync-2.0.0 → diffsync-2.0.1}/README.md

@@ -17,16 +17,16 @@ DiffSync is at its most useful when you have multiple sources or sets of data to
 
 DiffSync acts as an intermediate translation layer between all of the data sets you are diffing and/or syncing. In practical terms, this means that to use DiffSync, you will define a set of data models as well as the “adapters” needed to translate between each base data source and the data model. In Python terms, the adapters will be subclasses of the `Adapter` class, and each data model class will be a subclass of the `DiffSyncModel` class.
 
-![Diffsync Components](https://raw.githubusercontent.com/networktocode/diffsync/develop/docs/images/diffsync_components.png "Diffsync Components")
+![DiffSync Components](https://raw.githubusercontent.com/networktocode/diffsync/develop/docs/images/diffsync_components.png "DiffSync Components")
 
 
 Once you have used each adapter to load each data source into a collection of data model records, you can then ask DiffSync to “diff” the two data sets, and it will produce a structured representation of the difference between them. In Python, this is accomplished by calling the `diff_to()` or `diff_from()` method on one adapter and passing the other adapter as a parameter.
 
-![Diffsync Diff Creation](https://raw.githubusercontent.com/networktocode/diffsync/develop/docs/images/diffsync_diff_creation.png "Diffsync Diff Creation")
+![DiffSync Diff Creation](https://raw.githubusercontent.com/networktocode/diffsync/develop/docs/images/diffsync_diff_creation.png "DiffSync Diff Creation")
 
 You can also ask DiffSync to “sync” one data set onto the other, and it will instruct your adapter as to the steps it needs to take to make sure that its data set accurately reflects the other. In Python, this is accomplished by calling the `sync_to()` or `sync_from()` method on one adapter and passing the other adapter as a parameter.
 
-![Diffsync Sync](https://raw.githubusercontent.com/networktocode/diffsync/develop/docs/images/diffsync_sync.png "Diffsync Sync")
+![DiffSync Sync](https://raw.githubusercontent.com/networktocode/diffsync/develop/docs/images/diffsync_sync.png "DiffSync Sync")
 
 # Simple Example
 

{diffsync-2.0.0 → diffsync-2.0.1}/diffsync/__init__.py

@@ -28,7 +28,7 @@ from typing import (
     Any,
     Set,
 )
-import warnings
+from typing_extensions import deprecated
 
 from pydantic import ConfigDict, BaseModel, PrivateAttr
 import structlog  # type: ignore
@@ -425,7 +425,7 @@ class DiffSyncModel(BaseModel):
 
 
 class Adapter:  # pylint: disable=too-many-public-methods
-    """Class for storing a group of DiffSyncModel instances and diffing/synchronizing to another DiffSync instance."""
+    """Class for storing a group of DiffSyncModel instances and diffing/synchronizing to another Adapter instance."""
 
     # In any subclass, you would add mapping of names to specific model classes here:
     # modelname1 = MyModelClass1
@@ -480,7 +480,7 @@ class Adapter:  # pylint: disable=too-many-public-methods
                 raise AttributeError(f'top_level references attribute "{name}" but it is not a DiffSyncModel subclass!')
 
     def __str__(self) -> StrType:
-        """String representation of a DiffSync."""
+        """String representation of an Adapter."""
         if self.type != self.name:
             return f'{self.type} "{self.name}"'
         return self.type
@@ -526,7 +526,7 @@ class Adapter:  # pylint: disable=too-many-public-methods
         return data
 
     def str(self, indent: int = 0) -> StrType:
-        """Build a detailed string representation of this DiffSync."""
+        """Build a detailed string representation of this Adapter."""
         margin = " " * indent
         output = ""
         for modelname in self.top_level:
@@ -835,7 +835,7 @@ class Adapter:  # pylint: disable=too-many-public-methods
     def get_or_instantiate(
         self, model: Type[DiffSyncModel], ids: Dict, attrs: Optional[Dict] = None
     ) -> Tuple[DiffSyncModel, bool]:
-        """Attempt to get the object with provided identifiers or instantiate it with provided identifiers and attrs.
+        """Attempt to get the object with provided identifiers or instantiate and add it with provided identifiers and attrs.
 
         Args:
             model: The DiffSyncModel to get or create.
@@ -848,7 +848,7 @@ class Adapter:  # pylint: disable=too-many-public-methods
         return self.store.get_or_instantiate(model=model, ids=ids, attrs=attrs)
 
     def get_or_add_model_instance(self, obj: DiffSyncModel) -> Tuple[DiffSyncModel, bool]:
-        """Attempt to get the object with provided obj identifiers or instantiate obj.
+        """Attempt to get the object with provided obj identifiers or add obj.
 
         Args:
             obj: An obj of the DiffSyncModel to get or add.
@@ -894,15 +894,10 @@ class Adapter:  # pylint: disable=too-many-public-methods
         return self.store.count(model=model)
 
 
-def DiffSync(*args: Any, **kwargs: Any) -> Adapter:  # noqa  pylint: disable=invalid-name
+@deprecated("'diffsync.DiffSync' is deprecated and will be removed with 2.1, use 'diffsync.Adapter' instead.")
+class DiffSync(Adapter):
     """For backwards-compatibility, keep around the old name."""
 
-    warnings.warn(
-        "'diffsync.DiffSync' is deprecated and will be removed with 2.1, use 'diffsync.Adapter' instead.",
-        DeprecationWarning,
-    )
-    return Adapter(*args, **kwargs)
-
 
 # DiffSyncModel references Adapter and Adapter references DiffSyncModel. Break the typing loop:
 DiffSyncModel.model_rebuild()

{diffsync-2.0.0 → diffsync-2.0.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "diffsync"
-version = "v2.0.0"
+version = "v2.0.1"
 description = "Library to easily sync/diff/update 2 different data sources"
 authors = ["Network to Code, LLC <info@networktocode.com>"]
 license = "Apache-2.0"
@@ -18,7 +18,7 @@ include = [
 [tool.poetry.dependencies]
 python = ">=3.8,<4.0"
 pydantic = "^2.0.0"
-structlog = ">= 20.1.0, < 23.0.0"
+structlog = ">= 20.1.0"
 packaging = ">= 21.3, < 24.0"
 colorama = {version = "^0.4.3", optional = true}
 redis = {version = "^4.3", optional = true}
@@ -42,7 +42,7 @@ mypy = "*"
 pytest-cov = "*"
 pytest-structlog = "*"
 coverage = {extras = ["toml"], version = "*"}
-Sphinx = "*"
+Sphinx = "^6.0.0"
 m2r2 = "*"
 sphinx-rtd-theme = "*"
 toml = "*"