--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.UI.upgrader.html Thu Jul 07 11:23:56 2022 +0200 @@ -0,0 +1,102 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.UI.upgrader</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.UI.upgrader</h1> + +<p> +Script to upgrade the packages eric depends on. +</p> +<p> +This process must be performed while eric is closed. The script will upgrade +the requested packages and will restart eric. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>_ericPackages</td></tr><tr><td>_pyqtPackages</td></tr> +</table> +<h3>Classes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Functions</h3> + +<table> + +<tr> +<td><a href="#doUpgrade">doUpgrade</a></td> +<td>Function to upgrade the given packages via pip.</td> +</tr> +<tr> +<td><a href="#main">main</a></td> +<td>Main entry point into the upgrader.</td> +</tr> +<tr> +<td><a href="#startEric">startEric</a></td> +<td>Function to start eric with the given arguments.</td> +</tr> +</table> +<hr /> +<hr /> +<a NAME="doUpgrade" ID="doUpgrade"></a> +<h2>doUpgrade</h2> +<b>doUpgrade</b>(<i>packages</i>) + +<p> + Function to upgrade the given packages via pip. +</p> +<dl> + +<dt><i>packages</i> (list of str)</dt> +<dd> +list of packages to be upgraded +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating a successful installation +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="main" ID="main"></a> +<h2>main</h2> +<b>main</b>(<i></i>) + +<p> + Main entry point into the upgrader. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="startEric" ID="startEric"></a> +<h2>startEric</h2> +<b>startEric</b>(<i>args</i>) + +<p> + Function to start eric with the given arguments. +</p> +<dl> + +<dt><i>args</i> (list of str)</dt> +<dd> +list containing the start arguments +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file