Skip to content

Commit

Permalink
Add architecture diagram
Browse files Browse the repository at this point in the history
  • Loading branch information
stefanvogel committed Feb 11, 2025
1 parent 46ee8a3 commit 4ed5d98
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 2 deletions.
28 changes: 28 additions & 0 deletions doc/uml/architecture.puml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
@startuml ArchitectureDiagram

package "pyProfileMgr" {
component "Main entry point" as main
component "Jira server" as jira_server
component "Profile command" <<command>> as cmd_profile
component "Profile manager" as profile_mgr
}

package "Python Jira" {
component "jira.client.JIRA" as jira
}

package "Python" as python {
component "Argparse" as argparse
component "Requests" as requests
}

main o--> cmd_profile
cmd_profile o--> jira_server
cmd_profile o--> profile_mgr
jira_server o--> profile_mgr
main *--> argparse

jira_server *--> jira
jira *--> requests

@enduml
2 changes: 1 addition & 1 deletion doc/uml/deployment.puml
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ node "Continuous integration server" <<virtual-machine>> {
component "pyJiraCli" as jira_cli #White
component "pyMetricCli" as metric_cli #White
component "pyProfileMgr" as profile_mgr
ProfileMgr - [profile_mgr]
}

folder Filesystem {
file "Profile data" as profile_data_files
}

ProfileMgr - [profile_mgr]
jira_cli -> ProfileMgr
metric_cli --> ProfileMgr
profile_mgr -- profile_data_files
Expand Down
2 changes: 1 addition & 1 deletion src/pyProfileMgr/cmd_profile.py
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ def execute(_) -> Ret.CODE:
""" This function serves as entry point for the command 'profile'.
It will be stored as callback for this modules subparser command.
Args:
Args:
args (obj): The command line arguments.
Returns:
Expand Down

0 comments on commit 4ed5d98

Please sign in to comment.