buildzr 0.0.1__tar.gz → 0.0.2__tar.gz

{buildzr-0.0.1 → buildzr-0.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: buildzr
-Version: 0.0.1
+Version: 0.0.2
 Summary: Structurizr for the `buildzr`s 🧱⚒️
 Project-URL: homepage, https://github.com/amirulmenjeni/buildzr
 Project-URL: issues, https://github.com/amirulmenjeni/buildzr/issues
@@ -28,19 +28,26 @@ Requires-Dist: pytest-mypy==0.10.3; extra == 'dev'
 Requires-Dist: yq==3.4.3; extra == 'dev'
 Description-Content-Type: text/markdown
 
+test: 1
 # Structurizr for the `buildzr`s 🧱⚒️
 
 `buildzr` is a [Structurizr](https://structurizr.com/) authoring tool for Python programmers.
 
 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 +124,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 +141,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 → buildzr-0.0.2}/README.md

@@ -1,16 +1,23 @@
+test: 1
 # Structurizr for the `buildzr`s 🧱⚒️
 
 `buildzr` is a [Structurizr](https://structurizr.com/) authoring tool for Python programmers.
 
 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
 
@@ -87,7 +94,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.
 
@@ -101,7 +111,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.2/buildzr/__about__.py

@@ -0,0 +1 @@
+VERSION = "0.0.2"

buildzr-0.0.1/buildzr/__about__.py

@@ -1 +0,0 @@
-VERSION = "0.0.1"