Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > comp.lang.python > #197097

Re: How to go about describing my software with a component diagram?

Show all headers | View raw

marc nicole via Python-list <python-list@python.org> ezt írta (időpont:
2024. dec. 24., K 22:09):

> The full python package (pypi) being represented as the outermost frame
> here including the 4 sub-frames)
>
> Le mar. 24 déc. 2024 à 22:05, marc nicole <mk1853387@gmail.com> a écrit :
>
> > I want to convey the idea that main.py (main algorithm) imports 3 modules
> > (V, S, M) (each of them containing .py scripts related to
> > different functionalities) and use their methods accordingly as per the
> > requirement: basically the structure of my code and how the modules
> relate
> > to each other.
> >
> > Le mar. 24 déc. 2024 à 21:56, dn via Python-list <python-list@python.org
> >
> > a écrit :
> >
> >> On 25/12/24 06:27, marc nicole via Python-list wrote:
> >> > Hello community,
> >> >
> >> > I have created a Python code where a main algorithm uses three
> different
> >> > modules (.py) after importing them.
> >> >
> >> > To illustrate and describe it I have created the following component
> >> > diagram?
> >> >
> >> >
> >> > [image: checkso.PNG]
> >> >
> >> > Could it be improved for better description and readability?
> >>
> >>
> >> Possibly - so little detail as to topic and any hints in the diagram
> >> redacted! What messages do you want to communicate with this diagram?
> >>
> >> Given that the three modules are subordinate contributors to the
> >> script/algorithm, place the three modules inside a larger "Algorithm"
> >> shape.
> >>
> >> --
> >> Regards,
> >> =dn
> >> --
> >> https://mail.python.org/mailman/listinfo/python-list
> >>
> >
> --
> https://mail.python.org/mailman/listinfo/python-list



Hi,

also there are some tools which can generate class hierarchy diagram from
code.
for example here is a post
https://stackoverflow.com/questions/77421030/how-to-generate-the-uml-diagram-from-the-python-code

pyreverse is now part of pylint if I remember well.

BR
George

>
>

Back to comp.lang.python | Previous | Next | Find similar

Thread

Re: How to go about describing my software with a component diagram? George Fischhof <george@fischhof.hu> - 2024-12-24 23:00 +0100

csiph-web