Add example for generating relationship graphs

Signed-off-by: Holger Frydrych <[email protected]>

Author: fholger

examples/spdx2_generate_graph.py

@@ -0,0 +1,16 @@
+#  SPDX-FileCopyrightText: 2023 spdx contributors
+#
+#  SPDX-License-Identifier: Apache-2.0
+from os import path
+
+from spdx_tools.spdx.graph_generation import export_graph_from_document
+from spdx_tools.spdx.parser.parse_anything import parse_file
+
+# This example demonstrates how to generate a relationship graph for an SPDX2 document
+
+# Provide a path to the input file
+input_path = path.join(path.dirname(__file__), "..", "tests", "spdx", "data", "SPDXJSONExample-v2.3.spdx.json")
+# Parse the file
+document = parse_file(input_path)
+# Generate the graph (note: you need to have installed the optional dependency networkx, pygraphviz)
+export_graph_from_document(document, "graph.png")

tests/spdx/examples/test_examples.py

@@ -11,7 +11,7 @@
 def cleanup_output_files():
     yield
 
-    files_to_delete = ["spdx2_to_3.jsonld", "my_spdx_document.spdx.json", "converted_format.xml"]
+    files_to_delete = ["spdx2_to_3.jsonld", "my_spdx_document.spdx.json", "converted_format.xml", "graph.png"]
     for file in files_to_delete:
         output_file = os.path.join(os.path.dirname(__file__), file)
         if os.path.exists(output_file):
@@ -27,25 +27,39 @@ def test_spdx2_parse_file():
     run_example("spdx2_parse_file.py")
 
 
-@pytest.mark.usefixtures('cleanup_output_files')
+@pytest.mark.usefixtures("cleanup_output_files")
 def test_spdx2_convert_to_spdx3():
     run_example("spdx2_convert_to_spdx3.py")
 
     output_file = os.path.join(os.path.dirname(__file__), "spdx2_to_3.jsonld")
     assert os.path.exists(output_file)
 
 
-@pytest.mark.usefixtures('cleanup_output_files')
+@pytest.mark.usefixtures("cleanup_output_files")
 def test_spdx2_document_from_scratch():
     run_example("spdx2_document_from_scratch.py")
 
     output_file = os.path.join(os.path.dirname(__file__), "my_spdx_document.spdx.json")
     assert os.path.exists(output_file)
 
 
-@pytest.mark.usefixtures('cleanup_output_files')
+@pytest.mark.usefixtures("cleanup_output_files")
 def test_spdx2_convert_format():
     run_example("spdx2_convert_format.py")
 
     output_file = os.path.join(os.path.dirname(__file__), "converted_format.xml")
     assert os.path.exists(output_file)
+
+
+@pytest.mark.usefixtures("cleanup_output_files")
+def test_spdx2_generate_graph():
+    try:
+        import networkx  # noqa F401
+        import pygraphviz  # noqa F401
+    except ImportError:
+        pytest.skip("Missing optional dependencies")
+
+    run_example("spdx2_generate_graph.py")
+
+    output_file = os.path.join(os.path.dirname(__file__), "graph.png")
+    assert os.path.exists(output_file)