Documentation/Source/eric6.install.html

changeset 6215
4f4581b7a02a
parent 5651
982465f8389c
child 6495
6e73d31af3af
--- a/Documentation/Source/eric6.install.html	Wed Apr 04 19:48:25 2018 +0200
+++ b/Documentation/Source/eric6.install.html	Wed Apr 04 19:49:10 2018 +0200
@@ -91,6 +91,9 @@
 <td><a href="#main">main</a></td>
 <td>The main function of the script.</td>
 </tr><tr>
+<td><a href="#pipInstall">pipInstall</a></td>
+<td>Install the given package via pip.</td>
+</tr><tr>
 <td><a href="#prepareInfoFile">prepareInfoFile</a></td>
 <td>Function to prepare an Info.py file when installing from source.</td>
 </tr><tr>
@@ -366,6 +369,32 @@
 </dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
+<a NAME="pipInstall" ID="pipInstall"></a>
+<h2>pipInstall</h2>
+<b>pipInstall</b>(<i>packageName, message</i>)
+<p>
+    Install the given package via pip.
+</p><dl>
+<dt><i>packageName</i> (str)</dt>
+<dd>
+name of the package to be installed
+</dd><dt><i>message</i> (str)</dt>
+<dd>
+message to be shown to the user
+</dd>
+</dl><dl>
+<dt>Returns:</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="prepareInfoFile" ID="prepareInfoFile"></a>
 <h2>prepareInfoFile</h2>
 <b>prepareInfoFile</b>(<i>fileName</i>)

eric ide

mercurial