Welcome to DiffSync’s documentation!

Contents:

• Overview
  • Primary Use Cases
  • Overview of DiffSync
• Getting started
  • Define your model with DiffSyncModel
  • Define your system adapter with DiffSync
  • Store data in a Adapter object
  • Update remote system on sync
• Core Engine
• Global and Model Flags
  • Global flags
  • Model flags
  • Working with flags
• Custom Diff Class
  • Using your own Diff class
  • Change the order in which the element are being processed
• Store backends
  • Use the LocalStore Backend
  • Use the RedisStore Backend
• Examples
  • Example 1 - Multiple Data Sources
  • Example 2 - Callback Function
  • Example 3 - Work with a remote system
  • Example 4 - Using get or update helpers
  • Example 5 - PeeringDB to Nautobot synchronisation
  • Example 6 - IP Prefixes
• Upgrading
  • Upgrading to 2.0
• API Reference
  • Adapter
  • DiffSync
  • DiffSyncModel
  • diffsync.diff
  • diffsync.enum
  • diffsync.exceptions
  • diffsync.helpers
  • diffsync.logging
  • diffsync.utils
  • Subpackages
• License

Indices and tables

• Index

• Module Index