Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Component Node for C4 model #1000

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions diagrams/c4/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,19 @@ def C4Node(name, technology="", description="", type="Container", **kwargs):
return Node(**node_attributes)


def Component(name, technology="", description="", **kwargs):
container_attributes = {
"name": name,
"technology": technology,
"description": description,
"type": "Component",
"fillcolor": "lightskyblue",
"fontcolor": "black",
}
container_attributes.update(kwargs)
return C4Node(**container_attributes)


def Container(name, technology="", description="", **kwargs):
container_attributes = {
"name": name,
Expand Down
3 changes: 2 additions & 1 deletion tests/test_c4.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

from diagrams import Diagram
from diagrams import setcluster, setdiagram
from diagrams.c4 import Person, Container, Database, System, SystemBoundary, Relationship
from diagrams.c4 import Person, Container, Database, Component, System, SystemBoundary, Relationship


class C4Test(unittest.TestCase):
Expand All @@ -25,6 +25,7 @@ def test_nodes(self):
person = Person("person", "A person.")
container = Container("container", "Java application", "The application.")
database = Database("database", "Oracle database", "Stores information.")
component = Component("component", "Sign In Controller", "A component.")

def test_external_nodes(self):
with Diagram(name=self.name, show=False):
Expand Down