src/eric7/Documentation/Source/eric7.CycloneDXInterface.CycloneDXUtilities.html

branch
eric7
changeset 9509
c06561080e32
parent 9209
b99e7fd55fd3
child 10479
856476537696
--- a/src/eric7/Documentation/Source/eric7.CycloneDXInterface.CycloneDXUtilities.html	Sat Nov 12 17:49:08 2022 +0100
+++ b/src/eric7/Documentation/Source/eric7.CycloneDXInterface.CycloneDXUtilities.html	Sun Nov 13 14:10:57 2022 +0100
@@ -38,6 +38,14 @@
 <td>Function to amend the SBOM meta data according the given data.</td>
 </tr>
 <tr>
+<td><a href="#_prettifyJSON">_prettifyJSON</a></td>
+<td>Function to prettify the SBOM JSON output generated by CycloneDX.</td>
+</tr>
+<tr>
+<td><a href="#_prettifyXML">_prettifyXML</a></td>
+<td>Function to prettify the SBOM XML output generated by CycloneDX.</td>
+</tr>
+<tr>
 <td><a href="#addCycloneDXDependencies">addCycloneDXDependencies</a></td>
 <td>Function to add dependency data to the list of created components.</td>
 </tr>
@@ -166,6 +174,67 @@
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
+<a NAME="_prettifyJSON" ID="_prettifyJSON"></a>
+<h2>_prettifyJSON</h2>
+<b>_prettifyJSON</b>(<i>inputStr</i>)
+
+<p>
+    Function to prettify the SBOM JSON output generated by CycloneDX.
+</p>
+<dl>
+
+<dt><i>inputStr</i> (str)</dt>
+<dd>
+output generated by CycloneDX
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+prettified SBOM string
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="_prettifyXML" ID="_prettifyXML"></a>
+<h2>_prettifyXML</h2>
+<b>_prettifyXML</b>(<i>inputStr</i>)
+
+<p>
+    Function to prettify the SBOM XML output generated by CycloneDX.
+</p>
+<p>
+    Note: Prettifying an XML tree works only with Python 3.9 and above!
+</p>
+<dl>
+
+<dt><i>inputStr</i> (str)</dt>
+<dd>
+output generated by CycloneDX
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+prettified SBOM string
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
 <a NAME="addCycloneDXDependencies" ID="addCycloneDXDependencies"></a>
 <h2>addCycloneDXDependencies</h2>
 <b>addCycloneDXDependencies</b>(<i>parser, venvName</i>)

eric ide

mercurial