Groups > comp.lang.python > #197095

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	marc nicole <mk1853387@gmail.com>
Newsgroups	comp.lang.python
Subject	Re: How to go about describing my software with a component diagram?
Date	Tue, 24 Dec 2024 22:08:42 +0100
Lines	47
Message-ID	<mailman.23.1735074452.2912.python-list@python.org> (permalink)
References	<CAGJtH9SeSw6CJEgs37MQ9DJEADeQy4M_bAYPH1yeFiJN+mTLYQ@mail.gmail.com> <f5054d26-39ca-4bbb-8eb7-a8b0455c7966@DancesWithMice.info> <CAGJtH9TitodaW4uzrPg0omnEBzN=+FANLWYr+pdNu1MZAqeXvQ@mail.gmail.com> <CAGJtH9SihxgDSgYpVp1V7p-bKV1VM+WzG-bA2gR-_H14OWSTGw@mail.gmail.com>
Mime-Version	1.0
Content-Type	text/plain; charset="UTF-8"
Content-Transfer-Encoding	quoted-printable
X-Trace	news.uni-berlin.de D27mt1aup+kgNsff2v8SHQ5pt73xZcqBxbzF+nFCG6/Q==
Cancel-Lock	sha1:fn7jUlx67pw3l/StW+K9NYiYrHs= sha256:b7jBBrQT7b+IftQWHadJjia3zLuK2RVzTl7kCRvvTGk=
Return-Path	<mk1853387@gmail.com>
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=gmail.com header.i=@gmail.com header.b=Uz36krNT; dkim-adsp=pass; dkim-atps=neutral
X-Spam-Status	OK 0.022
X-Spam-Evidence	'H': 0.96; 'S': 0.00; 'containing': 0.05; 'modules': 0.07; 'url:mailman': 0.09; '=dn': 0.09; 'describe': 0.09; 'other.': 0.09; '>': 0.14; 'url:listinfo': 0.15; '.py': 0.16; 'accordingly': 0.16; 'diagram': 0.16; 'hints': 0.16; 'importing': 0.16; 'wrote:': 0.16; 'python': 0.16; 'larger': 0.17; 'uses': 0.19; 'to:addr:python-list': 0.20; 'url- ip:188.166.95.178/32': 0.20; 'url-ip:188.166.95/24': 0.20; 'basically': 0.22; 'communicate': 0.22; 'to:no real name:2**1': 0.22; 'code': 0.23; 'url-ip:188.166/16': 0.24; 'idea': 0.24; 'community,': 0.28; 'email addr:python.org>': 0.28; 'subject:How': 0.31; 'message-id:@mail.gmail.com': 0.31; 'python- list': 0.32; 'structure': 0.32; 'header:In-Reply-To:1': 0.34; 'received:google.com': 0.34; 'package': 0.34; 'from:addr:gmail.com': 0.34; 'following': 0.35; 'possibly': 0.36; 'main': 0.37; 'could': 0.37; '8bit%:14': 0.38; 'use': 0.39; 'methods': 0.39; 'want': 0.40; 'including': 0.60; 'detail': 0.61; 'here': 0.63; 'skip:b 10': 0.63; 'full': 0.64; 'improved': 0.64; '8bit%:7': 0.67; 'per': 0.68; 'relate': 0.69; 'little': 0.73; 'email name:<python-list': 0.84; 'imports': 0.84; 'mar.': 0.84; 'represented': 0.84; '\xc3\xa9crit\xc2\xa0:': 0.84; 'convey': 0.91
DKIM-Signature	v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1735074449; x=1735679249; darn=python.org; h=to:subject:message-id:date:from:in-reply-to:references:mime-version :from:to:cc:subject:date:message-id:reply-to; bh=7hOjjkOP8B9mmrIvoR78wd/zC2p2Ha2N+3STPz7QhF4=; b=Uz36krNTAiPU29ovbvpgrbHXENO5A3vwoGasaiTlaeVIeATCKA02UxalpNKPSApZ57 CqMyJd6iWUyZa2IhWIzHelDVnim6x5ZQUQk7O4m78e2Vaq/iPzSOIvkiPcJcuMt6KiH0 OsHIO3uqbi7r62duxoy1RCmT6cz6AtFjDSCZOXNGvaM9AFI39uP+CWiBExZzzLlPLh6P iUG2Hg2NpgYWF23TwGlRiOUh/Xm5HUZ+2cLp+TOZ93xP8vHzvKlYFDUdyFd6tcgBRH7h O5K1DSYs6pLk0LGYZ0n+fl6jmFI7sl7BgdMPIBx/1O+BeH/3isCSW5Wz56pspsqNMuH+ MI9g==
X-Google-DKIM-Signature	v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1735074449; x=1735679249; h=to:subject:message-id:date:from:in-reply-to:references:mime-version :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=7hOjjkOP8B9mmrIvoR78wd/zC2p2Ha2N+3STPz7QhF4=; b=dDPm/Rpyfq/heuV2Id/Ojpaen/6kSM5WOUntMUph5z0IVrR4Bp4i4arTK5WBccK0lj MyD9G1yM7HVcdJcupXpWBNhR0Ark8hKPgJLPdxi4d8uX17NgfPAR26yVYw+928V/sCrI lzf0OcmlOq/aekfmZXuBqql9N7l8ofDwVt2tQcpK/MlsqLProbNoBq05QGEBWtZZHFig U0T4wTWuIJaYsoFSmaV3YAbf0YjHPEMpGBVetl5FD5bBonsJo4GN/BDOyD3wc/OO82HD 5oaNg2bCsWdIiQbU7a36stbr6oLHyedQrQ2+e88oAs6Vm9lFjhhYvz6XH6TbYD8G+DDU kGLA==
X-Forwarded-Encrypted	i=1; AJvYcCVUPzCw8VRy8r1ypS8TbShtfhXWBY77FrkDNHIBpdTAwYeNzmTMcrwOMG9RMq8+GR0hg6GBiQ==@python.org, AJvYcCWWbBDup9YHw/TIbelc+WeXKu8ILYft/5G3BzsSibqBvK1OPpnUOJUYy0BDsIfOY7pE9J0ij6691UCCEbI=@python.org
X-Gm-Message-State	AOJu0YwQLE6+tmbWhXOaADzvig3jWrRjFq1U6qORoiGW4Wr6YcG3fUjX ARlq6oTO48xg3/+8E6JnjSQLn2YoxOAiXTYI5XnB39wZFiI9LE03SV0kFv8KM7/nYymM3wUR3hX 1/0/GbGmh0j32j1v/BMvpze95Yxs=
X-Gm-Gg	ASbGncuPHPr/2FWpGOpQ160ltMojK7GpmoycfFNoLe1VJ1KsZ7TJG/LbkstHpMrDmXR kEWsi6tdArbZ6bP7ybZLiMoolyH7ASMNBsUe+UQ==
X-Google-Smtp-Source	AGHT+IEGnY+P8/GDCqzXCFctPQwRi6PLsmWKTEarWpgH/OOAVVh5QqCBNiiZqqI2dtMBcmL1ehhesF63vZ5mcdsT4BY=
X-Received	by 2002:a05:6902:1209:b0:e38:f3f1:a15b with SMTP id 3f1490d57ef6-e538c403d90mr12243106276.50.1735074449333; Tue, 24 Dec 2024 13:07:29 -0800 (PST)
In-Reply-To	<CAGJtH9TitodaW4uzrPg0omnEBzN=+FANLWYr+pdNu1MZAqeXvQ@mail.gmail.com>
X-Content-Filtered-By	Mailman/MimeDel 2.1.39
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	<CAGJtH9SihxgDSgYpVp1V7p-bKV1VM+WzG-bA2gR-_H14OWSTGw@mail.gmail.com>
X-Mailman-Original-References	<CAGJtH9SeSw6CJEgs37MQ9DJEADeQy4M_bAYPH1yeFiJN+mTLYQ@mail.gmail.com> <f5054d26-39ca-4bbb-8eb7-a8b0455c7966@DancesWithMice.info> <CAGJtH9TitodaW4uzrPg0omnEBzN=+FANLWYr+pdNu1MZAqeXvQ@mail.gmail.com>
Xref	csiph.com comp.lang.python:197095

Show key headers only | View raw

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
>>
>

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

Thread

Re: How to go about describing my software with a component diagram? marc nicole <mk1853387@gmail.com> - 2024-12-24 22:08 +0100

csiph-web