Skip to content

sebkraemer/FinTsUml

Repository files navigation

https://github.com/sebkraemer/FinTsUml/actions/workflows/fints_uml.yml

About

This program supports conversion from Star Money transaction protocols to UML sequence diagrams as well as its internal kernel log format. It was developed to support my debugging efforts by getting a better overview.

It works by going through the file, grepping for FinTS message parts, filter invalid or unprintable characters, add line breaks and send the preprocessed data to a plantuml server which will return a SVG file which is saved to disc.

Run it

There are two options to run it:

  • Just call the script with the log file as parameter: python fints_uml.py <files>
  • If installed as a package, call it as module: python -m fints_uml <files>

Before you do that, note that currently, local instance of a plantuml server is necessary. This might appear cumbersome but avoids sending your data over the net in unencrypted form. This is not configurable yet. Adapt the target URL in the source if you need to, sorry.

Development

Developed in MacOS with python 3.8.

You need requests for running and pytest for testing 😀

More reference info can be gathered from setup.cfg and the Github actions files

Feel free to contact me or open issues or even PRs, I'll be happy to talk about your feedback and ideas.

About

FinTS UML diagram generation tool

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages