René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Docs Update: Clarify sublassing DiffSyncModels for different backends","articleBody":"### Environment\r\n* DiffSync version:  1.3.0\u003c!-- Example: 1.0.0 --\u003e\r\n\r\n\u003c!--\r\n    Describe in detail the new functionality you are proposing.\r\n--\u003e\r\n### Proposed Functionality\r\nThe README makes mention of extending a \"base\" DiffSyncModel for handling CRUD actions in a backend, but doesn't do a great job of visualizing this concept.\r\n\r\n\u003e you need to extend your DiffSyncModel class(es) to define your own create, update and/or delete methods for each model.\r\n\r\nI think extending the example out a little more would go a long way to showing how to build your models and adapters.\r\n\r\n```python\r\nclass Device(DiffSyncModel):\r\n    \"\"\"Example model of a network Device.\"\"\"\r\n​\r\n    _modelname = \"device\"\r\n    _identifiers = (\"name\",)\r\n    _attributes = ()\r\n    _children = {\"interface\": \"interfaces\"}\r\n​\r\n    name: str\r\n    site_name: Optional[str]  # note that this attribute is NOT included in _attributes\r\n    role: Optional[str]  # note that this attribute is NOT included in _attributes\r\n    interfaces: List = list()\r\n​\r\n​\r\nclass SystemADevice(Device):\r\n\r\n    system_A_unique_field: Optional[str] = None\r\n    \r\n    @classmethod\r\n    def create(cls, diffsync, ids, attrs):\r\n        \"\"\"Talk to SystemA to create device\"\"\"\r\n        pass\r\n​\r\nclass SystemBDevice(Device):\r\n    \r\n    system_B_unique_field: Optional[str] = None\r\n\r\n    @classmethod\r\n    def create(cls, diffsync, ids, attrs):\r\n        \"\"\"Talk to SystemB to create device\"\"\"\r\n        pass\r\n```\r\n\r\n\u003c!--\r\n    Convey an example use case for your proposed feature. Write from the\r\n    perspective of a user who would benefit from the proposed\r\n    functionality and describe how.\r\n--\u003e\r\n### Use Case\r\n\r\nThis should help newbies (like myself) to get a better idea of how to architect a diffsync-based integration.\r\n","author":{"url":"https://github.com/tyler-8","@type":"Person","name":"tyler-8"},"datePublished":"2021-06-03T04:42:23.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":1},"url":"https://github.com/52/diffsync/issues/52"}