Feature Request: Add Examples for Common Use Cases

[gamerquantannymars]

Request for Examples

Given that structurizr-python is primarily designed as a client for Structurizr, it would be beneficial to have examples of common use cases in the documentation. This could include:

1. Basic Setup: How to get started with the Python client.
2. Creating a Model: Step-by-step guide on how to create a simple model using the package.
3. Integrating with Structurizr DSL: Example of how to use the Python client alongside Structurizr DSL.

Providing examples will help users understand the capabilities and ease of use of this package, especially for those new to Structurizr or the Python client. It can enhance user experience significantly and potentially attract more contributors and users.

Looking forward to your thoughts on this suggestion!

[Midnighter]

Hey @gamerquantannymars,

As you have noticed, I'm not very active on this project any longer. In fact, until very recently, I had it in archive mode.

You are completely correct that some tutorials/examples are in order, but I'm honestly not sure when I find a moment to add them. My own workflow that I used this package for was:

Extract information from ServiceNow CMDB -> build workspace using this client -> store as workspace.json -> include and extend in further DSL projects. It worked well, but then we got LeanIX at my employer which has a direct ServiceNow integration.