Groups > comp.lang.python > #197093

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

Path	csiph.com!fu-berlin.de!uni-berlin.de!not-for-mail
From	dn <PythonList@DancesWithMice.info>
Newsgroups	comp.lang.python
Subject	Re: How to go about describing my software with a component diagram?
Date	Wed, 25 Dec 2024 09:46:43 +1300
Organization	DWM
Lines	24
Message-ID	<mailman.21.1735073614.2912.python-list@python.org> (permalink)
References	<CAGJtH9SeSw6CJEgs37MQ9DJEADeQy4M_bAYPH1yeFiJN+mTLYQ@mail.gmail.com> <f5054d26-39ca-4bbb-8eb7-a8b0455c7966@DancesWithMice.info>
Mime-Version	1.0
Content-Type	text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding	7bit
X-Trace	news.uni-berlin.de bOGL3OvYJdZsU4wY98OiwAYLO+ddHq98tgGqgraVxH5Q==
Cancel-Lock	sha1:dFp1wXcLw7OcEXwa69B4eVNrYWc= sha256:UDaevA5e2TGsAO5jTyoCQsTYvcU7nq90yrv/y3yWOho=
Return-Path	<PythonList@DancesWithMice.info>
X-Original-To	python-list@python.org
Delivered-To	python-list@mail.python.org
Authentication-Results	mail.python.org; dkim=pass reason="2048-bit key; unprotected key" header.d=danceswithmice.info header.i=@danceswithmice.info header.b=mADzVR0e; dkim-adsp=pass; dkim-atps=neutral
X-Spam-Status	OK 0.003
X-Spam-Evidence	'H': 0.99; 'S': 0.00; 'modules': 0.07; '=dn': 0.09; 'describe': 0.09; 'from:addr:danceswithmice.info': 0.09; 'from:addr:pythonlist': 0.09; 'diagram': 0.16; 'hints': 0.16; 'importing': 0.16; 'message-id:@DancesWithMice.info': 0.16; 'received:cloud': 0.16; 'received:rangi.cloud': 0.16; 'wrote:': 0.16; 'python': 0.16; 'larger': 0.17; 'uses': 0.19; 'to:addr :python-list': 0.20; 'communicate': 0.22; 'code': 0.23; 'community,': 0.28; 'header:User-Agent:1': 0.30; 'subject:How': 0.31; 'python-list': 0.32; 'header:Organization:1': 0.32; 'header :In-Reply-To:1': 0.34; 'following': 0.35; 'possibly': 0.36; 'main': 0.37; 'could': 0.37; 'received:192.168': 0.37; 'want': 0.40; 'detail': 0.61; 'improved': 0.64; 'little': 0.73
DKIM-Filter	OpenDKIM Filter v2.11.0 vps.rangi.cloud 974CE5A73
DKIM-Signature	v=1; a=rsa-sha256; c=relaxed/simple; d=danceswithmice.info; s=staff; t=1735073210; bh=9J1WS07Ip1zhe7r26HhzOmsTI7UvbseDjZRwkIrSWh8=; h=Date:From:Subject:To:References:In-Reply-To:From; b=mADzVR0eKA+KFnc3nfztUz3CwKrdQT4IZsOqoudsrJFzCoD1+fa5Z2inu/SAtgcIi brOso3DjBjKV7sGmoNFKMgSNgAvo9IuL2JIPqAAtrELt+f8oUYSPk5o7LOyWcVor9q ihpP6tYV4XYxk7qESj7Vi8FNi4Kr4//Aip4hBFrhVPF+vKA+1/BQxFbrlGstr/R47b 2dFCMPxQZ3dE8ZJhHAJKyhDFmwt0lbIUt3WvLQoYRUvXIIp8R3UGKNFfyblIYJ6erB K6/Jwh1j0Mayoce80nDR6e9Cv592qDMdoooLhiuVbOHrSTKE1uT6vEJnbgcUi+JXUV 0rt80DihGsMfA==
User-Agent	Mozilla Thunderbird
Content-Language	en-US
In-Reply-To	<CAGJtH9SeSw6CJEgs37MQ9DJEADeQy4M_bAYPH1yeFiJN+mTLYQ@mail.gmail.com>
X-BeenThere	python-list@python.org
X-Mailman-Version	2.1.39
Precedence	list
List-Id	General discussion list for the Python programming language <python-list.python.org>
List-Unsubscribe	<https://mail.python.org/mailman/options/python-list>, <mailto:python-list-request@python.org?subject=unsubscribe>
List-Archive	<https://mail.python.org/pipermail/python-list/>
List-Post	<mailto:python-list@python.org>
List-Help	<mailto:python-list-request@python.org?subject=help>
List-Subscribe	<https://mail.python.org/mailman/listinfo/python-list>, <mailto:python-list-request@python.org?subject=subscribe>
X-Mailman-Original-Message-ID	<f5054d26-39ca-4bbb-8eb7-a8b0455c7966@DancesWithMice.info>
X-Mailman-Original-References	<CAGJtH9SeSw6CJEgs37MQ9DJEADeQy4M_bAYPH1yeFiJN+mTLYQ@mail.gmail.com>
Xref	csiph.com comp.lang.python:197093

Show key headers only | View raw

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

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

Thread

Re: How to go about describing my software with a component diagram? dn <PythonList@DancesWithMice.info> - 2024-12-25 09:46 +1300

csiph-web