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

branch
eric7
changeset 9117
c6afba2049cf
child 9123
aefb731a4b4e
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/eric7/Documentation/Source/eric7.CycloneDXInterface.CycloneDXUtilities.html	Fri Jun 03 19:54:57 2022 +0200
@@ -0,0 +1,112 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.CycloneDXInterface.CycloneDXUtilities</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.CycloneDXInterface.CycloneDXUtilities</h1>
+
+<p>
+Module implementing the interface to CycloneDX.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#CycloneDXEnvironmentParser">CycloneDXEnvironmentParser</a></td>
+<td>Class implementing a parser to get package data for a named environment.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+
+<tr>
+<td><a href="#createCycloneDXFile">createCycloneDXFile</a></td>
+<td>Function to create a CyccloneDX SBOM file.</td>
+</tr>
+</table>
+<hr />
+<hr />
+<a NAME="CycloneDXEnvironmentParser" ID="CycloneDXEnvironmentParser"></a>
+<h2>CycloneDXEnvironmentParser</h2>
+
+<p>
+    Class implementing a parser to get package data for a named environment.
+</p>
+<h3>Derived from</h3>
+BaseParser
+<h3>Class Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Class Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+
+<table>
+
+<tr>
+<td><a href="#CycloneDXEnvironmentParser.__init__">CycloneDXEnvironmentParser</a></td>
+<td>Constructor</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="CycloneDXEnvironmentParser.__init__" ID="CycloneDXEnvironmentParser.__init__"></a>
+<h4>CycloneDXEnvironmentParser (Constructor)</h4>
+<b>CycloneDXEnvironmentParser</b>(<i>venvName</i>)
+
+<p>
+        Constructor
+</p>
+<dl>
+
+<dt><i>venvName</i> (str)</dt>
+<dd>
+name of the virtual environment
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="createCycloneDXFile" ID="createCycloneDXFile"></a>
+<h2>createCycloneDXFile</h2>
+<b>createCycloneDXFile</b>(<i>venvName</i>)
+
+<p>
+    Function to create a CyccloneDX SBOM file.
+</p>
+<dl>
+
+<dt><i>venvName</i> (str)</dt>
+<dd>
+name of the virtual environment
+</dd>
+</dl>
+<dl>
+
+<dt>Raises <b>RuntimeError</b>:</dt>
+<dd>
+raised to indicate illegal creation parameters
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial