Groups > comp.lang.python > #197094

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:05:35 +0100
Lines	39
Message-ID	<mailman.22.1735074266.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>
Mime-Version	1.0
Content-Type	text/plain; charset="UTF-8"
Content-Transfer-Encoding	quoted-printable
X-Trace	news.uni-berlin.de ndpLj/DhGB7USQ+YBO6dygqV03I2N8n4WoqgZcoMpPDA==
Cancel-Lock	sha1:PuHn104MaJzWRqJa7ovbEgflaaU= sha256:dw8vH0AXQCm/uhniVzsOTdbGH3IXYxM6ZdtKxXQ/xxY=
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=djhFmitU; dkim-adsp=pass; dkim-atps=neutral
X-Spam-Status	OK 0.011
X-Spam-Evidence	'H': 0.98; '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; '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; 'detail': 0.61; 'skip:b 10': 0.63; 'improved': 0.64; '8bit%:7': 0.67; 'per': 0.68; 'relate': 0.69; 'little': 0.73; 'email name:&lt ;python-list': 0.84; 'imports': 0.84; 'mar.': 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=1735074262; x=1735679062; 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=U7xewik5ABq7eSyA4zs1IXcx0bDHOaKHyedddU44hps=; b=djhFmitUOfvymlvEWD05glpwO2ByZT0GUlpIT/ywShR8Lx5X28h3cnAmY7BNYPe+3+ cAGRCS0UoUcf44FdEJhg9uaP/mUdjrF2Pv90I58538MoJImbw/z4ly2MRAElszt+1v+K nJe9NzkXI6twQ7jeID8NkE8UDQhjrNan6IpIH6AGuVBwIWy+JdCW/Ylu8fgMA7QOCFIO 6Uk5SDtC1/qozTyrmf3sTZlg0KFu6A6w7NR0Q2TmXUHo/b897fpEUxFekcietuZVG9fr W7eHvxxHq8zaR/soMYcTvn6dWaXqivzG3t1FHxEbM5og5oV/4yYX2ZJuk6YfYcT6JMAe jHqQ==
X-Google-DKIM-Signature	v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1735074262; x=1735679062; 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=U7xewik5ABq7eSyA4zs1IXcx0bDHOaKHyedddU44hps=; b=Z0ZyTV7miayqlHQT9NfIVTt1/VBF1tk95bqmXR/HsGsbEnNJlxwr+UI499wRs04Kxs elcZs8Axt/sTrjMEQXpE3774GmDaEVIU19KcEHQJoqoqWwo8pWXJhaaH8jNJcnBtm6UG wUCcGMdv5g1mJyMrEwE7krli8wY7Mnz9bflOJqKJOQtLxVFHxpci06LQ3qLwPrUvXgOK fUSf0mLK30FbGIDXwrg5OAcAvSSMbDJ3VvbtW27rYV1NGUz8PDBgmoxXa0ucxWq/RUO7 VB2R4Nta5n/m7kWnEWaqO5IHcEIn9motzrR1uIwbJFbsXM17wbCoWBYaIruOB6dtdnAU SOyg==
X-Forwarded-Encrypted	i=1; AJvYcCWwP9DCXHvTNtV7eoCq//j3B2dcD906fP7q5OPaOYM22rp8Jlss69AxgLueycxPiPZ1DcE6sw==@python.org, AJvYcCXLT6BUO/Bc+0ZN2hygeJti9kYxtj0sIlwtUfLrBQ5cyJCBPLWP6+GEazLK3I4aqYZA0FZxgWPAXDQ8k3g=@python.org
X-Gm-Message-State	AOJu0Yw7aLcKg5z1ynskffBL0dol67bflq8oVumUdgzgqaaF6gmq+LZ2 qSZt7cB9YrKzuGYUpQVmW0g4i7ezFVYkQ++cRNSlwvXKm4TWNzCpid9pfFOhr4F6lE5/qDdpaAL d5o0HU2DMdT6PLpKFvS8Xtmm+F8bR7lMr
X-Gm-Gg	ASbGncv3a1ivqREGG8Lt+5VVD4DfAJYa4W+mYRrTGHtxtZBmHjqHVs4lVIc9XdK1p3/ TGtUb60skOldcwQgGqshiI6n0LukiugUsy1wTCA==
X-Google-Smtp-Source	AGHT+IHF02qf4usZwqNzSy0cfRayre9HYxA98+1mDZR9K65irBq/ml+6AcTQgEqSToU0n2gI++kqABeYqHkioHbTbBs=
X-Received	by 2002:a05:6902:2e0c:b0:e53:5eca:de59 with SMTP id 3f1490d57ef6-e538c2328a7mr14280742276.13.1735074262265; Tue, 24 Dec 2024 13:04:22 -0800 (PST)
In-Reply-To	<f5054d26-39ca-4bbb-8eb7-a8b0455c7966@DancesWithMice.info>
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	<CAGJtH9TitodaW4uzrPg0omnEBzN=+FANLWYr+pdNu1MZAqeXvQ@mail.gmail.com>
X-Mailman-Original-References	<CAGJtH9SeSw6CJEgs37MQ9DJEADeQy4M_bAYPH1yeFiJN+mTLYQ@mail.gmail.com> <f5054d26-39ca-4bbb-8eb7-a8b0455c7966@DancesWithMice.info>
Xref	csiph.com comp.lang.python:197094

Show key headers only | View raw

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:05 +0100

csiph-web