You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
DiffSync is a utility library that can be used to compare and synchronize different datasets.
5
4
6
5
For example, it can be used to compare a list of devices from 2 inventory systems and, if required, synchronize them in either direction.
7
6
8
-
# Primary Use Cases
7
+
##Primary Use Cases
9
8
10
9
DiffSync is at its most useful when you have multiple sources or sets of data to compare and/or synchronize, and especially if any of the following are true:
11
10
@@ -14,7 +13,7 @@ DiffSync is at its most useful when you have multiple sources or sets of data to
14
13
- If various types of data in your data set naturally form a tree-like or parent-child relationship with other data.
15
14
- If the different data sets have some attributes in common and other attributes that are exclusive to one or the other.
16
15
17
-
# Overview of DiffSync
16
+
##Overview of DiffSync
18
17
19
18
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.
20
19
@@ -29,7 +28,7 @@ You can also ask DiffSync to “sync” one data set onto the other, and it will
Pull requests are welcomed and automatically built and tested against multiple versions of Python through GitHub Actions.
73
80
74
81
The project is following Network to Code software development guidelines and is leveraging the following:
75
82
76
-
-Black, Pylint, Bandit, flake8, and pydocstyle, mypy for Python linting, formatting and type hint checking.
83
+
-Ruff, mypy for Python linting, formatting and type hint checking.
77
84
- pytest, coverage, and unittest for unit tests.
78
85
79
86
You can ensure your contribution adheres to these checks by running `invoke tests` from the CLI.
80
87
The command `invoke build` builds a docker container with all the necessary dependencies (including the redis backend) locally to facilitate the execution of these tests.
81
88
82
-
# Questions
83
-
Please see the [documentation](https://diffsync.readthedocs.io/en/latest/index.html) for detailed documentation on how to use `diffsync`. For any additional questions or comments, feel free to swing by the [Network to Code slack channel](https://networktocode.slack.com/) (channel #networktocode). Sign up [here](http://slack.networktocode.com/)
84
-
=======
85
-
# Diffsync
86
-
87
-
<!--
88
-
Developer Note - Remove Me!
89
-
90
-
The README will have certain links/images broken until the PR is merged into `develop`. Update the GitHub links with whichever branch you're using (main etc.) if different.
91
-
92
-
The logo of the project is a placeholder (docs/images/icon-diffsync.png) - please replace it with your app icon, making sure it's at least 200x200px and has a transparent background!
93
-
94
-
To avoid extra work and temporary links, make sure that publishing docs (or merging a PR) is done at the same time as setting up the docs site on RTD, then test everything.
You can find all the Markdown source for the App documentation under the [`docs`](https://github.com/networktocode/diffsync/tree/develop/docs) folder in this repository. For simple edits, a Markdown capable editor is sufficient: clone the repository and edit away.
124
92
@@ -129,4 +97,3 @@ Any PRs with fixes or improvements are very welcome!
129
97
## Questions
130
98
131
99
For any questions or comments, please check the [FAQ](https://diffsync.readthedocs.io/en/latest/user/faq/) first. Feel free to also swing by the [Network to Code Slack](https://networktocode.slack.com/) (channel `#networktocode`), sign up [here](http://slack.networktocode.com/) if you don't have an account.
0 commit comments