annotate scripts/schema_diagram.py @ 8478:ed4ef394d5d6

doc: initial attempt to document setup of pgp support for email. Used an AI assistant to help write this. Basic gpg commands seem to work, but I have not tested this totally. Docs basically follow the setup used for pgp testing in the test suite. It looks like roundup accepts signed emails as well as encrypted and signed emails. But it does not generate signed emails. Also it looks like there is no PGP support for alternate email addresses. Only primary addresses can do PGP emails.
author John Rouillard <rouilj@ieee.org>
date Sat, 15 Nov 2025 16:59:24 -0500
parents 23b8e6067f7c
children 9c3ec0a5c7fc
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1166
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1 #! /usr/bin/python
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2 #
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3 # Schema diagram generator contributed by Stefan Seefeld of the fresco
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
4 # project http://www.fresco.org/.
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
5 #
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
6 # It generates a 'dot file' that is then fed into the 'dot'
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
7 # tool (http://www.graphviz.org) to generate a graph:
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
8 #
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
9 # %> ./schema.py
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
10 # %> dot -Tps schema.dot -o schema.ps
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
11 # %> gv schema.ps
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
12 #
5376
64b05e24dbd8 Python 3 preparation: convert print to a function.
Joseph Myers <jsm@polyomino.org.uk>
parents: 1166
diff changeset
13 from __future__ import print_function
1166
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
14 import sys
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
15 import roundup.instance
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
16
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
17 # open the instance
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
18 instance = roundup.instance.open(sys.argv[1])
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
19 db = instance.open()
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
20
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
21 # diagram preamble
5376
64b05e24dbd8 Python 3 preparation: convert print to a function.
Joseph Myers <jsm@polyomino.org.uk>
parents: 1166
diff changeset
22 print('digraph schema {')
64b05e24dbd8 Python 3 preparation: convert print to a function.
Joseph Myers <jsm@polyomino.org.uk>
parents: 1166
diff changeset
23 print('size="8,6"')
64b05e24dbd8 Python 3 preparation: convert print to a function.
Joseph Myers <jsm@polyomino.org.uk>
parents: 1166
diff changeset
24 print('node [shape="record" bgcolor="#ffe4c4" style=filled]')
64b05e24dbd8 Python 3 preparation: convert print to a function.
Joseph Myers <jsm@polyomino.org.uk>
parents: 1166
diff changeset
25 print('edge [taillabel="1" headlabel="1" dir=back arrowtail=ediamond]')
1166
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
26
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
27 # get all the classes
5395
23b8e6067f7c Python 3 preparation: update calls to dict methods.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
28 types = list(db.classes.keys())
1166
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
29
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
30 # one record node per class
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
31 for i in range(len(types)):
5376
64b05e24dbd8 Python 3 preparation: convert print to a function.
Joseph Myers <jsm@polyomino.org.uk>
parents: 1166
diff changeset
32 print('node%d [label=\"{%s|}"]'%(i, types[i]))
1166
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
33
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
34 # now draw in the relations
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
35 for name in db.classes.keys():
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
36 type = db.classes[name]
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
37 attributes = type.getprops()
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
38 for a in attributes.keys():
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
39 attribute = attributes[a]
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
40 if isinstance(attribute, roundup.hyperdb.Link):
5376
64b05e24dbd8 Python 3 preparation: convert print to a function.
Joseph Myers <jsm@polyomino.org.uk>
parents: 1166
diff changeset
41 print('node%d -> node%d [label=%s]'%(types.index(name),
1166
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
42 types.index(attribute.classname),
5376
64b05e24dbd8 Python 3 preparation: convert print to a function.
Joseph Myers <jsm@polyomino.org.uk>
parents: 1166
diff changeset
43 a))
1166
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
44 elif isinstance(attribute, roundup.hyperdb.Multilink):
5376
64b05e24dbd8 Python 3 preparation: convert print to a function.
Joseph Myers <jsm@polyomino.org.uk>
parents: 1166
diff changeset
45 print('node%d -> node%d [taillabel="*" label=%s]'%(types.index(name),
1166
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
46 types.index(attribute.classname),
5376
64b05e24dbd8 Python 3 preparation: convert print to a function.
Joseph Myers <jsm@polyomino.org.uk>
parents: 1166
diff changeset
47 a))
1166
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
48 # all done
5376
64b05e24dbd8 Python 3 preparation: convert print to a function.
Joseph Myers <jsm@polyomino.org.uk>
parents: 1166
diff changeset
49 print('}')

Roundup Issue Tracker: http://roundup-tracker.org/