reorganize examples

nielsvanspauwen · Jul 27, 2023 · 36b3a5d · 36b3a5d
1 parent 1801151
commit 36b3a5d
Show file tree

Hide file tree

Showing 11 changed files with 9 additions and 9 deletions.
diff --git a/example/README.md → examples/module_example/README.md b/example/README.md → examples/module_example/README.md
@@ -9,13 +9,13 @@ For the purpose of this example, assume Team A works on the core chat product, a
 
 The `workspace.py` file brings the different models and software systems together, and adds toplevel relationships between them.
 
-Finally, multipe view files (`componentview.py`, `containerview.py`, `systemlandscapeview.py`) describe which views to generate an SVG for.
+Finally, multipe view files (`chatserver_componentview.py`, `chatsystem_containerview.py`, `analysissystem_containerview.py` `systemlandscapeview.py`) describe which views to generate an SVG for.
 
 To run the example, you would for instance do:
 ```
-$ pystructurizr dev --view example.componentview
+$ pystructurizr dev --view examples.module_example.systemlandscapeview
 ```
 or 
 ```
-$ pystructurizr build --view example.containerview --gcs-credentials <...> --bucket-name <...> --object-name <...>
+$ pystructurizr build --view examples.module_example.systemlandscapeview --gcs-credentials <...> --bucket-name <...> --object-name <...>
 ```
diff --git a/example/__init__.py → examples/module_example/__init__.py b/example/__init__.py → examples/module_example/__init__.py
diff --git a/example/analysissystem.py → examples/module_example/analysissystem.py b/example/analysissystem.py → examples/module_example/analysissystem.py
diff --git a/example/analysisystem_containerview.py → ...le_example/analysisystem_containerview.py b/example/analysisystem_containerview.py → ...le_example/analysisystem_containerview.py
@@ -1,6 +1,6 @@
-from example.workspace import workspace
-from example.analysissystem import analysis_system
-from example.chatsystem import chat_server
+from .workspace import workspace
+from .analysissystem import analysis_system
+from .chatsystem import chat_server
 
 workspace.ContainerView(
     analysis_system,

diff --git a/example/chatserver_componentview.py → ...odule_example/chatserver_componentview.py b/example/chatserver_componentview.py → ...odule_example/chatserver_componentview.py
diff --git a/example/chatsystem.py → examples/module_example/chatsystem.py b/example/chatsystem.py → examples/module_example/chatsystem.py
diff --git a/example/chatsystem_containerview.py → ...odule_example/chatsystem_containerview.py b/example/chatsystem_containerview.py → ...odule_example/chatsystem_containerview.py
diff --git a/example/systemlandscapeview.py → ...les/module_example/systemlandscapeview.py b/example/systemlandscapeview.py → ...les/module_example/systemlandscapeview.py
diff --git a/example/users.py → examples/module_example/users.py b/example/users.py → examples/module_example/users.py
diff --git a/example/workspace.py → examples/module_example/workspace.py b/example/workspace.py → examples/module_example/workspace.py
@@ -1,8 +1,8 @@
 from pystructurizr.dsl import Workspace
 
-from example.users import users
-from example.chatsystem import chat
-from example.analysissystem import analytics
+from .users import users
+from .chatsystem import chat
+from .analysissystem import analytics
 
 workspace = Workspace()
 workspace.Model(users)

diff --git a/single_file_example.py → examples/single_file_example.py b/single_file_example.py → examples/single_file_example.py