eric7/Documentation/Source/eric7.UI.upgrader.html

<!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>None</td></tr>
</table>
<h3>Classes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Functions</h3>

<table>

<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>
<tr>
<td><a href="#upgradeEric">upgradeEric</a></td>
<td>Function to upgrade the eric-ide package via pip.</td>
</tr>
<tr>
<td><a href="#upgradePyQt">upgradePyQt</a></td>
<td>Function to upgrade the PyQt packages via pip.</td>
</tr>
</table>
<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 />
<hr />
<a NAME="upgradeEric" ID="upgradeEric"></a>
<h2>upgradeEric</h2>
<b>upgradeEric</b>(<i></i>)

<p>
    Function to upgrade the eric-ide package via pip.
</p>
<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="upgradePyQt" ID="upgradePyQt"></a>
<h2>upgradePyQt</h2>
<b>upgradePyQt</b>(<i></i>)

<p>
    Function to upgrade the PyQt packages via pip.
</p>
<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 />
</body></html>