Merge pull request #263 from networktocode/main

Promote `develop` to 2.0

Author: Kircheneer

.flake8

@@ -2,3 +2,4 @@
 # E501: Line length is enforced by Black, so flake8 doesn't need to check it
 # W503: Black disagrees with this rule, as does PEP 8; Black wins
 ignore = E501, W503
+exclude = .venv

.github/workflows/ci.yml

@@ -130,18 +130,20 @@ jobs:
       fail-fast: true
       matrix:
         python-version: ["3.8", "3.9", "3.10", "3.11"]
+        poetry-version: ["1.5.1"]
     runs-on: "ubuntu-20.04"
     env:
       PYTHON_VER: "${{ matrix.python-version }}"
     steps:
       - name: "Check out repository code"
         uses: "actions/checkout@v2"
       - name: "Setup environment"
-        uses: "networktocode/gh-action-setup-poetry-environment@v5"
+        uses: "networktocode/gh-action-setup-poetry-environment@3ea5d3ecf382cdcb0c74d4c0ff0629d95fce63c7"
         env:
           POETRY_VERSION: 1.5.1
         with:
           python-version: "${{ matrix.python-version }}"
+          poetry-version: "${{ matrix.poetry-version }}"
       - name: "Install redis"
         run: "sudo apt-get install -y redis"
       - name: "Run poetry Install"

CHANGELOG.md

@@ -1,6 +1,16 @@
 # Changelog
 
-## v1.10.0 - 2023-11-16
+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.0]
+
+### Changed
+
+- **BREAKING CHANGE** #236/240 - Upgrade to Pydantic v2. 
+
+## [1.10.0] - 2023-11-16
 
 ### Fixed
 
@@ -11,7 +21,7 @@
 
 - #247 - Deprecates Python 3.7
 
-## v1.9.0 - 2023-10-16
+## [1.9.0] - 2023-10-16
 
 ### Added
 
@@ -21,7 +31,7 @@
 
 - #219 - Type hinting overhaul 
 
-## v1.8.0 - 2023-04-18
+## [1.8.0] - 2023-04-18
 
 ### Added
 
@@ -34,7 +44,7 @@
 - #77/#188 - `sync_from()` and `sync_to()` now return the `Diff` that was applied.
 - #211 - Loosened `packaging` and `structlog` library dependency constraints for broader compatibility.
 
-## v1.7.0 - 2022-11-03
+## [1.7.0] - 2022-11-03
 
 ### Changed
 
@@ -52,15 +62,15 @@
 
 ### Fixed
 
-- #149 Limit redundant CI concurrency
+- #149 - Limit redundant CI concurrency
 
-## v1.6.0 - 2022-07-09
+## [1.6.0] - 2022-07-09
 
 ### Changed
 
 - #120 - Dropped support for Python 3.6, new minimum is Python 3.7
 
-## v1.5.1 - 2022-06-30
+## [1.5.1] - 2022-06-30
 
 ### Added
 
@@ -75,13 +85,13 @@
 - #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
+## [1.5.0] - 2022-06-07
 
 ### Added
 
 - #106 - Add a new, optional, backend store based in Redis
 
-## v1.4.3 - 2022-03-03
+## [1.4.3] - 2022-03-03
 
 ### Fixed
 
@@ -91,25 +101,25 @@
 
 ### Changed
 
-- #103 Update development dependencies
+- #103 - Update development dependencies
 
-## v1.4.2 - 2022-02-28
+## [1.4.2] - 2022-02-28
 
 **WARNING** - #90 inadvertently introduced a breaking API change in DiffSync 1.4.0 through 1.4.2 (#101); this change was reverted in #102 for DiffSync 1.4.3 and later. We recommend not using this release, and moving to 1.4.3 instead.
 
 ### Fixed
 
 - #100 - Added explicit dependency on `packaging`.
 
-## v1.4.1 - 2022-01-26
+## [1.4.1] - 2022-01-26
 
 **WARNING** - #90 inadvertently introduced a breaking API change in DiffSync 1.4.0 through 1.4.2 (#101); this change was reverted in #102 for DiffSync 1.4.3 and later. We recommend not using this release, and moving to 1.4.3 instead.
 
 ### Fixed
 
 - #95 - Removed optional dependencies on `sphinx`, `m2r2`, `sphinx-rtd-theme`, `toml`.
 
-## v1.4.0 - 2022-01-24
+## [1.4.0] - 2022-01-24
 
 **WARNING** - #90 inadvertently introduced a breaking API change in DiffSync 1.4.0 through 1.4.2 (#101); this change was reverted in #102 for DiffSync 1.4.3 and later. We recommend not using this release, and moving to 1.4.3 instead.
 
@@ -138,19 +148,19 @@
 - #51 - Update minimum Pydantic version due to security advisory GHSA-5jqp-qgf6-3pvh
 - #63 - Fix type in Readme
 
-## v1.3.0 - 2021-04-07
+## [1.3.0] - 2021-04-07
 
 ### Added
 
 - #48 - added optional `callback` argument to `diff_from`/`diff_to`/`sync_from`/`sync_to` for use with progress reporting.
 
-## v1.2.0 - 2020-12-08
+## [1.2.0] - 2020-12-08
 
 ### Added
 
 - #45 - minimum Python version lowered from 3.7 to 3.6, also now tested against Python 3.9.
 
-## v1.1.0 - 2020-12-01
+## [1.1.0] - 2020-12-01
 
 ### Added
 
@@ -168,6 +178,6 @@
 
 - #44 - On CRUD failure, do not generate an extraneous "success" log message in addition to the "failed" message
 
-## v1.0.0 - 2020-10-23
+## [1.0.0] - 2020-10-23
 
 Initial release

Dockerfile

@@ -8,7 +8,7 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
   && rm -rf /var/lib/apt/lists/*
 
 RUN pip install --upgrade pip \
-  && pip install poetry
+  && pip install poetry==1.5.1
 
 
 WORKDIR /local

README.md

@@ -15,7 +15,7 @@ DiffSync is at its most useful when you have multiple sources or sets of data to
 
 # Overview of DiffSync
 
-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 `DiffSync` class, and each data model class will be a subclass of the `DiffSyncModel` class.
+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")