add automatically generated UML class diagrams, potentially as a pre-commit hook

[LukasGold]

This Medium article suggests that automatically generated UML class diagrams are available using Pylint's Pyreverse, which is also integratable into a pre-commit hook.

I would recommend to integrate this into osw-python, as the generated diagrams are compatible to Mermaid as described in the Pyreverse docs.

IMO, this would help alot with understanding the class structure of the osw package and could also be beneficial for working with the Pydantic data models that are generated by the osw package from JSON.

[SimonStier]

+ Mermaid is supported within Markdown by Gitlab, Github and MediaWiki

Example:

graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;