buildzr 0.0.1__py3-none-any.whl → 0.0.3__py3-none-any.whl

buildzr/__about__.py

@@ -1 +1 @@
-VERSION = "0.0.1"
+VERSION = "0.0.3"

{buildzr-0.0.1.dist-info → buildzr-0.0.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: buildzr
-Version: 0.0.1
+Version: 0.0.3
 Summary: Structurizr for the `buildzr`s 🧱⚒️
 Project-URL: homepage, https://github.com/amirulmenjeni/buildzr
 Project-URL: issues, https://github.com/amirulmenjeni/buildzr/issues
@@ -34,13 +34,19 @@ Description-Content-Type: text/markdown
 
 If you're not familiar with Structurizr, it is both an open standard (see [Structurizr JSON schema](https://github.com/structurizr/json)) and a [set of tools](https://docs.structurizr.com/usage) for building software architecture diagrams as code. Structurizr derive its architecture modeling paradigm based on the [C4 model](https://c4model.com/), the modeling language for visualizing software architecture.
 
-`buildzr` offers flexible and fluent APIs to write software architecture models based on the C4 model, leveraging the standard Structurizr JSON schema for interoperability with various rendering and authoring tools.
+`buildzr` offers flexible and fluent APIs to write software architecture models,
+leveraging the standard Structurizr JSON schema for interoperability with
+various rendering and authoring tools.
 
 # Quick Start 🚀
 
 ## Installation
 
-_TODO_
+You can use `pip` to install the `buildzr` package:
+
+```bash
+pip install buildzr
+```
 
 ## Creating a workspace
 
@@ -117,7 +123,10 @@ with open(os.path.join(os.path.curdir, f"{__file__.split('.')[0]}.json"), 'w', e
     json.dump(w.model, f, ensure_ascii=False, indent=4, cls=JsonEncoder)
 ```
 
-That's it 😊!
+Here's a short breakdown on what's happening:
+- In `Workspace(...).contains(...)` method, we define the _static_ C4 models (i.e., `Person`, `SoftwareSystem`, and the `Container`s in the software system).
+- In the `Workspace(...).contains(...).where(...)`, we define the relationships between the C4 models in the workspace. We access the models via the `w` parameter in the `lambda` function, and create the relationships using the `>>` operators.
+- Finally, once we have all the models and their relationships defined, we use (and re-use!) the static models to create multiple views to tell different stories and show various narrative to help document your software architecture.
 
 The JSON output can be found [here](examples/system_context_and_container_view.json). You can also try out https://structurizr.com/json to see how this workspace will be rendered.
 
@@ -131,7 +140,7 @@ The JSON output can be found [here](examples/system_context_and_container_view.j
 
 ✅ Writing architecture diagrams in Python allows you to integrate programmability and automation into your software architecture diagramming and documentation workflow.
 
-✅ Uses the familiar Python programming language to write predicates for including/excluding elements and relationships in views.
+✅ Uses the familiar Python programming language to write software architecture diagrams!
 
 # Contributing
 

{buildzr-0.0.1.dist-info → buildzr-0.0.3.dist-info}/RECORD

@@ -1,4 +1,4 @@
-buildzr/__about__.py,sha256=t_QiCcOQDjV4pl-PMvif1IH68nAKKe0wdeizhaDsDds,17
+buildzr/__about__.py,sha256=I2Vn_6CtMpEXMvSx6Hq-8gFMpQjcK0IEyrty84xCLD0,17
 buildzr/__init__.py,sha256=hY-cOdjBQcz0v2m8cBF1oEJFIbcR3sWI-xww--0RKSo,99
 buildzr/dsl/__init__.py,sha256=paxuMCCDuOs1eSvBPyuW5pv5j1UZD6TxRZcCzC2iKss,307
 buildzr/dsl/dsl.py,sha256=X5lJJhD9dQ7YlRAECdXJb9qJKWfrfi-1H5rESYOnGhI,34584
@@ -14,7 +14,7 @@ buildzr/encoders/encoder.py,sha256=9_FlQ3aYvz0EcN_G9A3bPdqxCTkLhc2OrYXSYti95f8,2
 buildzr/models/__init__.py,sha256=SRfF7oDVlOOAi6nGKiJIUK6B_arqYLO9iSMp-2IZZps,21
 buildzr/models/generate.sh,sha256=924UoEXr5WBZ926TZfRgEQGHwBqtLGU5k0G2UfExLEg,1061
 buildzr/models/models.py,sha256=0LhLG1wmbt4dvROV5MEBZLLoxPbMpkUsOqNz525cynE,42489
-buildzr-0.0.1.dist-info/METADATA,sha256=MeUQrhtTNUePTVwRFQn0jdw74IDqV7MIzKoaELGBksE,5573
-buildzr-0.0.1.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-buildzr-0.0.1.dist-info/licenses/LICENSE.md,sha256=e8e6W6tL4MbBY-c-gXMgDbaMf_BnaQDQv4Yoy42b-CI,1070
-buildzr-0.0.1.dist-info/RECORD,,
+buildzr-0.0.3.dist-info/METADATA,sha256=ZMR0vrJYqT1S1Irlytx0TuxqhJ-2TtOP2_VZr6_h_0I,6255
+buildzr-0.0.3.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+buildzr-0.0.3.dist-info/licenses/LICENSE.md,sha256=e8e6W6tL4MbBY-c-gXMgDbaMf_BnaQDQv4Yoy42b-CI,1070
+buildzr-0.0.3.dist-info/RECORD,,