Mercurial Repositories > eric / file comparison
comparison: eric7/Documentation/Source/eric7.CycloneDXInterface.CycloneDXUtilities.html
eric7/Documentation/Source/eric7.CycloneDXInterface.CycloneDXUtilities.html
- branch
- eric7
- changeset 9117
- c6afba2049cf
- child 9123
- aefb731a4b4e
equal
deleted
inserted
replaced
| 9116:698660ef7350 | 9117:c6afba2049cf |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.CycloneDXInterface.CycloneDXUtilities</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.CycloneDXInterface.CycloneDXUtilities</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the interface to CycloneDX. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#CycloneDXEnvironmentParser">CycloneDXEnvironmentParser</a></td> | |
| 25 <td>Class implementing a parser to get package data for a named environment.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 | |
| 32 <tr> | |
| 33 <td><a href="#createCycloneDXFile">createCycloneDXFile</a></td> | |
| 34 <td>Function to create a CyccloneDX SBOM file.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <hr /> | |
| 38 <hr /> | |
| 39 <a NAME="CycloneDXEnvironmentParser" ID="CycloneDXEnvironmentParser"></a> | |
| 40 <h2>CycloneDXEnvironmentParser</h2> | |
| 41 | |
| 42 <p> | |
| 43 Class implementing a parser to get package data for a named environment. | |
| 44 </p> | |
| 45 <h3>Derived from</h3> | |
| 46 BaseParser | |
| 47 <h3>Class Attributes</h3> | |
| 48 | |
| 49 <table> | |
| 50 <tr><td>None</td></tr> | |
| 51 </table> | |
| 52 <h3>Class Methods</h3> | |
| 53 | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 | |
| 59 <table> | |
| 60 | |
| 61 <tr> | |
| 62 <td><a href="#CycloneDXEnvironmentParser.__init__">CycloneDXEnvironmentParser</a></td> | |
| 63 <td>Constructor</td> | |
| 64 </tr> | |
| 65 </table> | |
| 66 <h3>Static Methods</h3> | |
| 67 | |
| 68 <table> | |
| 69 <tr><td>None</td></tr> | |
| 70 </table> | |
| 71 | |
| 72 <a NAME="CycloneDXEnvironmentParser.__init__" ID="CycloneDXEnvironmentParser.__init__"></a> | |
| 73 <h4>CycloneDXEnvironmentParser (Constructor)</h4> | |
| 74 <b>CycloneDXEnvironmentParser</b>(<i>venvName</i>) | |
| 75 | |
| 76 <p> | |
| 77 Constructor | |
| 78 </p> | |
| 79 <dl> | |
| 80 | |
| 81 <dt><i>venvName</i> (str)</dt> | |
| 82 <dd> | |
| 83 name of the virtual environment | |
| 84 </dd> | |
| 85 </dl> | |
| 86 <div align="right"><a href="#top">Up</a></div> | |
| 87 <hr /> | |
| 88 <hr /> | |
| 89 <a NAME="createCycloneDXFile" ID="createCycloneDXFile"></a> | |
| 90 <h2>createCycloneDXFile</h2> | |
| 91 <b>createCycloneDXFile</b>(<i>venvName</i>) | |
| 92 | |
| 93 <p> | |
| 94 Function to create a CyccloneDX SBOM file. | |
| 95 </p> | |
| 96 <dl> | |
| 97 | |
| 98 <dt><i>venvName</i> (str)</dt> | |
| 99 <dd> | |
| 100 name of the virtual environment | |
| 101 </dd> | |
| 102 </dl> | |
| 103 <dl> | |
| 104 | |
| 105 <dt>Raises <b>RuntimeError</b>:</dt> | |
| 106 <dd> | |
| 107 raised to indicate illegal creation parameters | |
| 108 </dd> | |
| 109 </dl> | |
| 110 <div align="right"><a href="#top">Up</a></div> | |
| 111 <hr /> | |
| 112 </body></html> |
