buildzr 0.0.1__py3-none-any.whl

buildzr-0.0.1.dist-info/METADATA

@@ -0,0 +1,140 @@
+Metadata-Version: 2.3
+Name: buildzr
+Version: 0.0.1
+Summary: Structurizr for the `buildzr`s 🧱⚒️
+Project-URL: homepage, https://github.com/amirulmenjeni/buildzr
+Project-URL: issues, https://github.com/amirulmenjeni/buildzr/issues
+Author-email: Amirul Menjeni <amirulmenjeni@pm.me>
+License-File: LICENSE.md
+Keywords: architecture,buildzr,c4model,design,diagram,structurizr
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Requires-Dist: pyhumps==3.8.0
+Requires-Dist: pytest>=8.3.3
+Provides-Extra: dev
+Requires-Dist: datamodel-code-generator==0.26.2; extra == 'dev'
+Requires-Dist: jsondiff==2.0.0; extra == 'dev'
+Requires-Dist: mypy-extensions==1.0.0; extra == 'dev'
+Requires-Dist: mypy==1.11.2; extra == 'dev'
+Requires-Dist: pytest-mypy==0.10.3; extra == 'dev'
+Requires-Dist: yq==3.4.3; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# 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.
+
+# Quick Start 🚀
+
+## Installation
+
+_TODO_
+
+## Creating a workspace
+
+The module `buildzr.dsl` contains all the classes you need to create a workspace containing all the architecture models.
+
+Below is an example, where we:
+1. Create the models (`Person`, `SoftwareSystem`s, the `Container`s inside the `SoftwareSystem`, and the relationships between them)
+2. Define multiple views using the models we've created before.
+
+```python
+import os
+import json
+
+from buildzr.encoders import JsonEncoder
+
+from buildzr.dsl import (
+    Workspace,
+    SoftwareSystem,
+    Person,
+    Container,
+    SystemContextView,
+    ContainerView,
+    desc,
+    Group,
+)
+
+w = Workspace('w')\
+    .contains(
+        Group(
+            "My Company",
+            Person('Web Application User').labeled('u'),
+            SoftwareSystem('Corporate Web App').labeled('webapp')
+            .contains(
+                Container('database'),
+                Container('api'),
+            )\
+            .where(lambda s: [
+                s.api >> "Reads and writes data from/to" >> s.database,
+            ])
+        ),
+        Group(
+            "Microsoft",
+            SoftwareSystem('Microsoft 365').labeled('email_system'),
+        )
+    )\
+    .where(lambda w: [
+        w.person().u >> [
+            desc("Reads and writes email using") >> w.software_system().email_system,
+            desc("Create work order using") >> w.software_system().webapp,
+        ],
+        w.software_system().webapp >> "sends notification using" >> w.software_system().email_system,
+    ])\
+    .with_views(
+        SystemContextView(
+            lambda w: w.software_system().webapp,
+            key='web_app_system_context_00',
+            description="Web App System Context",
+            auto_layout='lr',
+            exclude_elements=[
+                lambda w, e: w.person().user == e,
+            ]
+        ),
+        ContainerView(
+            lambda w: w.software_system().webapp,
+            key='web_app_container_view_00',
+            auto_layout='lr',
+            description="Web App Container View",
+        )
+    )\
+    .get_workspace()
+
+# Writes the Workspace model to a JSON file.
+with open(os.path.join(os.path.curdir, f"{__file__.split('.')[0]}.json"), 'w', encoding='utf-8') as f:
+    json.dump(w.model, f, ensure_ascii=False, indent=4, cls=JsonEncoder)
+```
+
+That's it 😊!
+
+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.
+
+# Why use `buildzr`?
+
+✅ Uses fluent APIs to help you create C4 model architecture diagrams in Python concisely.
+
+✅ Write Structurizr diagrams more securely with extensive type hints and [mypy](https://mypy-lang.org) support.
+
+✅ Stays true to the [Structurizr JSON schema](https://mypy-lang.org/) standards. `buildzr` uses the [datamodel-code-generator](https://github.com/koxudaxi/datamodel-code-generator) to automatically generate the "low-level" [representation](buildzr/models/models.py) of the Workspace model. This reduces deprecancy between `buildzr` and the Structurizr JSON schema.
+
+✅ 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.
+
+# Contributing
+
+Interested in contributing to `buildzr`?
+
+Please visit [CONTRIBUTING.md](CONTRIBUTING.md).

buildzr-0.0.1.dist-info/RECORD

@@ -0,0 +1,20 @@
+buildzr/__about__.py,sha256=t_QiCcOQDjV4pl-PMvif1IH68nAKKe0wdeizhaDsDds,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
+buildzr/dsl/explorer.py,sha256=numMPqD3RYJ1oeMgX5wYnT6aHRHmBN2EsFZFYRuFffA,2523
+buildzr/dsl/expression.py,sha256=UinOUL3nJytZR8ylnVtVkJ0YoWoWspU9DQeDpg0nIEQ,6927
+buildzr/dsl/relations.py,sha256=aIXtbvpwSeW3QpWD_whtiIP8AOYPOpfCtFIrhM8NIkc,12253
+buildzr/dsl/factory/__init__.py,sha256=niaYqvNPUWJejoPyRyABUtzVsoxaV8eSjzS9dta4bMI,30
+buildzr/dsl/factory/gen_id.py,sha256=LnaeOCMngSvYkcGnuARjQYoUVWdcOoNHO2EHe6PMGco,538
+buildzr/dsl/interfaces/__init__.py,sha256=T0Az1IDLsTUYHoaGBStbS5V-acaJAlFUpDo-6Q0MrOY,229
+buildzr/dsl/interfaces/interfaces.py,sha256=Y3mqvXpiiZ-GRq3LhHAONq0Ft-Qzn40wje8zynHWJpM,4957
+buildzr/encoders/__init__.py,sha256=suID63Ay-023T0uKD25EAoGYmAMTa9AKxIjioccpiPM,32
+buildzr/encoders/encoder.py,sha256=9_FlQ3aYvz0EcN_G9A3bPdqxCTkLhc2OrYXSYti95f8,2237
+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.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.25.0
+Root-Is-Purelib: true
+Tag: py3-none-any

buildzr-0.0.1.dist-info/licenses/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Amirul Menjeni
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.