Initial objective:

• Arrive at a list of possible tools/services to perform automatic UML diagram gen

15 June 2022:

• @Amirali Investigated usability of pylint→pyreverse. Result: It seems to work.

Resulting diagram for payload-designer\payload_designer\components\diffractors.py:

To Do 1:

1. check whether the UML-diagram-generator is working properly.

2. Find out how to embed the code into the project using github

David: pylint is already implemented for commits, look into having pylint hook run the pyreverse function as part of the hook to autogenerate UML diagram into README.

31/08/2022:

Using github’s workflow, I managed to edit the code such that a UML diagram of the repo is generated at each command. Following is the forked repo where the feature is implmented:

https://github.com/amiralitor7/payload-designer/tree/UML-Generator

Problem: messy commit history; each time a commit is done, a second commit happens to produce the UML diagram and put it in the repo.

Possible solution (recommended by David): use precommit hooks.

Artifacts