Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.install.html
eric6/Documentation/Source/eric6.install.html
- branch
- maintenance
- changeset 6989
- 8b8cadf8d7e9
- parent 6942
- 2602857055c5
equal
deleted
inserted
replaced
| 6938:7926553b7509 | 6989:8b8cadf8d7e9 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.install</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.install</h1> | |
| 23 <p> | |
| 24 Installation script for the eric6 IDE and all eric6 related tools. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>BlackLists</td></tr><tr><td>PlatformsBlackLists</td></tr><tr><td>PythonMarkers</td></tr><tr><td>PythonTextMarkers</td></tr><tr><td>apisDir</td></tr><tr><td>cfg</td></tr><tr><td>configLength</td></tr><tr><td>configName</td></tr><tr><td>currDir</td></tr><tr><td>defaultMacAppBundleName</td></tr><tr><td>defaultMacAppBundlePath</td></tr><tr><td>defaultMacPythonExe</td></tr><tr><td>distDir</td></tr><tr><td>doCleanDesktopLinks</td></tr><tr><td>doCleanup</td></tr><tr><td>doCompile</td></tr><tr><td>forceCleanDesktopLinks</td></tr><tr><td>includePythonVariant</td></tr><tr><td>installApis</td></tr><tr><td>macAppBundleName</td></tr><tr><td>macAppBundlePath</td></tr><tr><td>macPythonExe</td></tr><tr><td>modDir</td></tr><tr><td>platBinDir</td></tr><tr><td>platBinDirOld</td></tr><tr><td>progLanguages</td></tr><tr><td>progName</td></tr><tr><td>pyModDir</td></tr><tr><td>pyqtOverride</td></tr><tr><td>pyqtVariant</td></tr><tr><td>sourceDir</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr><td>None</td></tr> | |
| 33 </table> | |
| 34 <h3>Functions</h3> | |
| 35 <table> | |
| 36 <tr> | |
| 37 <td><a href="#__pyName">__pyName</a></td> | |
| 38 <td>Local function to create the Python source file name for the compiled .ui file.</td> | |
| 39 </tr><tr> | |
| 40 <td><a href="#cleanUp">cleanUp</a></td> | |
| 41 <td>Uninstall the old eric files.</td> | |
| 42 </tr><tr> | |
| 43 <td><a href="#cleanUpLinuxSpecifics">cleanUpLinuxSpecifics</a></td> | |
| 44 <td>Clean up Linux specific files.</td> | |
| 45 </tr><tr> | |
| 46 <td><a href="#cleanUpMacAppBundle">cleanUpMacAppBundle</a></td> | |
| 47 <td>Uninstall the macOS application bundle.</td> | |
| 48 </tr><tr> | |
| 49 <td><a href="#cleanUpWindowsLinks">cleanUpWindowsLinks</a></td> | |
| 50 <td>Clean up the Desktop and Start Menu entries for Windows.</td> | |
| 51 </tr><tr> | |
| 52 <td><a href="#cleanupSource">cleanupSource</a></td> | |
| 53 <td>Cleanup the sources directory to get rid of leftover files and directories.</td> | |
| 54 </tr><tr> | |
| 55 <td><a href="#compileUiFiles">compileUiFiles</a></td> | |
| 56 <td>Compile the .ui files to Python sources.</td> | |
| 57 </tr><tr> | |
| 58 <td><a href="#copyAppStreamFile">copyAppStreamFile</a></td> | |
| 59 <td>Modify an appstream file and write it to its destination.</td> | |
| 60 </tr><tr> | |
| 61 <td><a href="#copyDesktopFile">copyDesktopFile</a></td> | |
| 62 <td>Modify a desktop file and write it to its destination.</td> | |
| 63 </tr><tr> | |
| 64 <td><a href="#copyToFile">copyToFile</a></td> | |
| 65 <td>Copy a string to a file.</td> | |
| 66 </tr><tr> | |
| 67 <td><a href="#copyTree">copyTree</a></td> | |
| 68 <td>Copy Python, translation, documentation, wizards configuration, designer template files and DTDs of a directory tree.</td> | |
| 69 </tr><tr> | |
| 70 <td><a href="#createConfig">createConfig</a></td> | |
| 71 <td>Create a config file with the respective config entries.</td> | |
| 72 </tr><tr> | |
| 73 <td><a href="#createGlobalPluginsDir">createGlobalPluginsDir</a></td> | |
| 74 <td>Create the global plugins directory, if it doesn't exist.</td> | |
| 75 </tr><tr> | |
| 76 <td><a href="#createInstallConfig">createInstallConfig</a></td> | |
| 77 <td>Create the installation config dictionary.</td> | |
| 78 </tr><tr> | |
| 79 <td><a href="#createLinuxSpecifics">createLinuxSpecifics</a></td> | |
| 80 <td>Install Linux specific files.</td> | |
| 81 </tr><tr> | |
| 82 <td><a href="#createMacAppBundle">createMacAppBundle</a></td> | |
| 83 <td>Create a Mac application bundle.</td> | |
| 84 </tr><tr> | |
| 85 <td><a href="#createPyWrapper">createPyWrapper</a></td> | |
| 86 <td>Create an executable wrapper for a Python script.</td> | |
| 87 </tr><tr> | |
| 88 <td><a href="#createWindowsLinks">createWindowsLinks</a></td> | |
| 89 <td>Create Desktop and Start Menu links.</td> | |
| 90 </tr><tr> | |
| 91 <td><a href="#createWindowsShortcut">createWindowsShortcut</a></td> | |
| 92 <td>Create Windows shortcut.</td> | |
| 93 </tr><tr> | |
| 94 <td><a href="#determinePyQtVariant">determinePyQtVariant</a></td> | |
| 95 <td>Module function to determine the PyQt variant to be used.</td> | |
| 96 </tr><tr> | |
| 97 <td><a href="#doDependancyChecks">doDependancyChecks</a></td> | |
| 98 <td>Perform some dependency checks.</td> | |
| 99 </tr><tr> | |
| 100 <td><a href="#exit">exit</a></td> | |
| 101 <td>Exit the install script.</td> | |
| 102 </tr><tr> | |
| 103 <td><a href="#getWinregEntry">getWinregEntry</a></td> | |
| 104 <td>Function to get an entry from the Windows Registry.</td> | |
| 105 </tr><tr> | |
| 106 <td><a href="#initGlobals">initGlobals</a></td> | |
| 107 <td>Module function to set the values of globals that need more than a simple assignment.</td> | |
| 108 </tr><tr> | |
| 109 <td><a href="#installEric">installEric</a></td> | |
| 110 <td>Actually perform the installation steps.</td> | |
| 111 </tr><tr> | |
| 112 <td><a href="#main">main</a></td> | |
| 113 <td>The main function of the script.</td> | |
| 114 </tr><tr> | |
| 115 <td><a href="#pipInstall">pipInstall</a></td> | |
| 116 <td>Install the given package via pip.</td> | |
| 117 </tr><tr> | |
| 118 <td><a href="#prepareInfoFile">prepareInfoFile</a></td> | |
| 119 <td>Function to prepare an Info.py file when installing from source.</td> | |
| 120 </tr><tr> | |
| 121 <td><a href="#shutilCopy">shutilCopy</a></td> | |
| 122 <td>Wrapper function around shutil.copy() to ensure the permissions.</td> | |
| 123 </tr><tr> | |
| 124 <td><a href="#usage">usage</a></td> | |
| 125 <td>Display a usage message and exit.</td> | |
| 126 </tr><tr> | |
| 127 <td><a href="#windowsDesktopEntries">windowsDesktopEntries</a></td> | |
| 128 <td>Function to generate data for the Windows Desktop links.</td> | |
| 129 </tr><tr> | |
| 130 <td><a href="#windowsDesktopNames">windowsDesktopNames</a></td> | |
| 131 <td>Function to generate the link names for the Windows Desktop.</td> | |
| 132 </tr><tr> | |
| 133 <td><a href="#windowsProgramsEntry">windowsProgramsEntry</a></td> | |
| 134 <td>Function to generate the name of the Start Menu top entry.</td> | |
| 135 </tr><tr> | |
| 136 <td><a href="#wrapperNames">wrapperNames</a></td> | |
| 137 <td>Create the platform specific names for the wrapper script.</td> | |
| 138 </tr> | |
| 139 </table> | |
| 140 <hr /><hr /> | |
| 141 <a NAME="__pyName" ID="__pyName"></a> | |
| 142 <h2>__pyName</h2> | |
| 143 <b>__pyName</b>(<i>py_dir, py_file</i>) | |
| 144 <p> | |
| 145 Local function to create the Python source file name for the compiled | |
| 146 .ui file. | |
| 147 </p><dl> | |
| 148 <dt><i>py_dir</i></dt> | |
| 149 <dd> | |
| 150 suggested name of the directory (string) | |
| 151 </dd><dt><i>py_file</i></dt> | |
| 152 <dd> | |
| 153 suggested name for the compile source file (string) | |
| 154 </dd> | |
| 155 </dl><dl> | |
| 156 <dt>Returns:</dt> | |
| 157 <dd> | |
| 158 tuple of directory name (string) and source file name (string) | |
| 159 </dd> | |
| 160 </dl> | |
| 161 <div align="right"><a href="#top">Up</a></div> | |
| 162 <hr /><hr /> | |
| 163 <a NAME="cleanUp" ID="cleanUp"></a> | |
| 164 <h2>cleanUp</h2> | |
| 165 <b>cleanUp</b>(<i></i>) | |
| 166 <p> | |
| 167 Uninstall the old eric files. | |
| 168 </p> | |
| 169 <div align="right"><a href="#top">Up</a></div> | |
| 170 <hr /><hr /> | |
| 171 <a NAME="cleanUpLinuxSpecifics" ID="cleanUpLinuxSpecifics"></a> | |
| 172 <h2>cleanUpLinuxSpecifics</h2> | |
| 173 <b>cleanUpLinuxSpecifics</b>(<i></i>) | |
| 174 <p> | |
| 175 Clean up Linux specific files. | |
| 176 </p> | |
| 177 <div align="right"><a href="#top">Up</a></div> | |
| 178 <hr /><hr /> | |
| 179 <a NAME="cleanUpMacAppBundle" ID="cleanUpMacAppBundle"></a> | |
| 180 <h2>cleanUpMacAppBundle</h2> | |
| 181 <b>cleanUpMacAppBundle</b>(<i></i>) | |
| 182 <p> | |
| 183 Uninstall the macOS application bundle. | |
| 184 </p> | |
| 185 <div align="right"><a href="#top">Up</a></div> | |
| 186 <hr /><hr /> | |
| 187 <a NAME="cleanUpWindowsLinks" ID="cleanUpWindowsLinks"></a> | |
| 188 <h2>cleanUpWindowsLinks</h2> | |
| 189 <b>cleanUpWindowsLinks</b>(<i></i>) | |
| 190 <p> | |
| 191 Clean up the Desktop and Start Menu entries for Windows. | |
| 192 </p> | |
| 193 <div align="right"><a href="#top">Up</a></div> | |
| 194 <hr /><hr /> | |
| 195 <a NAME="cleanupSource" ID="cleanupSource"></a> | |
| 196 <h2>cleanupSource</h2> | |
| 197 <b>cleanupSource</b>(<i>dirName</i>) | |
| 198 <p> | |
| 199 Cleanup the sources directory to get rid of leftover files | |
| 200 and directories. | |
| 201 </p><dl> | |
| 202 <dt><i>dirName</i></dt> | |
| 203 <dd> | |
| 204 name of the directory to prune (string) | |
| 205 </dd> | |
| 206 </dl> | |
| 207 <div align="right"><a href="#top">Up</a></div> | |
| 208 <hr /><hr /> | |
| 209 <a NAME="compileUiFiles" ID="compileUiFiles"></a> | |
| 210 <h2>compileUiFiles</h2> | |
| 211 <b>compileUiFiles</b>(<i></i>) | |
| 212 <p> | |
| 213 Compile the .ui files to Python sources. | |
| 214 </p> | |
| 215 <div align="right"><a href="#top">Up</a></div> | |
| 216 <hr /><hr /> | |
| 217 <a NAME="copyAppStreamFile" ID="copyAppStreamFile"></a> | |
| 218 <h2>copyAppStreamFile</h2> | |
| 219 <b>copyAppStreamFile</b>(<i>src, dst, marker</i>) | |
| 220 <p> | |
| 221 Modify an appstream file and write it to its destination. | |
| 222 </p><dl> | |
| 223 <dt><i>src</i></dt> | |
| 224 <dd> | |
| 225 source file name (string) | |
| 226 </dd><dt><i>dst</i></dt> | |
| 227 <dd> | |
| 228 destination file name (string) | |
| 229 </dd><dt><i>marker</i></dt> | |
| 230 <dd> | |
| 231 marker to be used (string) | |
| 232 </dd> | |
| 233 </dl> | |
| 234 <div align="right"><a href="#top">Up</a></div> | |
| 235 <hr /><hr /> | |
| 236 <a NAME="copyDesktopFile" ID="copyDesktopFile"></a> | |
| 237 <h2>copyDesktopFile</h2> | |
| 238 <b>copyDesktopFile</b>(<i>src, dst, marker</i>) | |
| 239 <p> | |
| 240 Modify a desktop file and write it to its destination. | |
| 241 </p><dl> | |
| 242 <dt><i>src</i></dt> | |
| 243 <dd> | |
| 244 source file name (string) | |
| 245 </dd><dt><i>dst</i></dt> | |
| 246 <dd> | |
| 247 destination file name (string) | |
| 248 </dd><dt><i>marker</i></dt> | |
| 249 <dd> | |
| 250 marker to be used (string) | |
| 251 </dd> | |
| 252 </dl> | |
| 253 <div align="right"><a href="#top">Up</a></div> | |
| 254 <hr /><hr /> | |
| 255 <a NAME="copyToFile" ID="copyToFile"></a> | |
| 256 <h2>copyToFile</h2> | |
| 257 <b>copyToFile</b>(<i>name, text</i>) | |
| 258 <p> | |
| 259 Copy a string to a file. | |
| 260 </p><dl> | |
| 261 <dt><i>name</i></dt> | |
| 262 <dd> | |
| 263 the name of the file. | |
| 264 </dd><dt><i>text</i></dt> | |
| 265 <dd> | |
| 266 the contents to copy to the file. | |
| 267 </dd> | |
| 268 </dl> | |
| 269 <div align="right"><a href="#top">Up</a></div> | |
| 270 <hr /><hr /> | |
| 271 <a NAME="copyTree" ID="copyTree"></a> | |
| 272 <h2>copyTree</h2> | |
| 273 <b>copyTree</b>(<i>src, dst, filters, excludeDirs=None, excludePatterns=None</i>) | |
| 274 <p> | |
| 275 Copy Python, translation, documentation, wizards configuration, | |
| 276 designer template files and DTDs of a directory tree. | |
| 277 </p><dl> | |
| 278 <dt><i>src</i></dt> | |
| 279 <dd> | |
| 280 name of the source directory | |
| 281 </dd><dt><i>dst</i></dt> | |
| 282 <dd> | |
| 283 name of the destination directory | |
| 284 </dd><dt><i>filters</i></dt> | |
| 285 <dd> | |
| 286 list of filter pattern determining the files to be copied | |
| 287 </dd><dt><i>excludeDirs</i></dt> | |
| 288 <dd> | |
| 289 list of (sub)directories to exclude from copying | |
| 290 </dd><dt><i>excludePatterns=</i></dt> | |
| 291 <dd> | |
| 292 list of filter pattern determining the files to | |
| 293 be skipped | |
| 294 </dd> | |
| 295 </dl> | |
| 296 <div align="right"><a href="#top">Up</a></div> | |
| 297 <hr /><hr /> | |
| 298 <a NAME="createConfig" ID="createConfig"></a> | |
| 299 <h2>createConfig</h2> | |
| 300 <b>createConfig</b>(<i></i>) | |
| 301 <p> | |
| 302 Create a config file with the respective config entries. | |
| 303 </p> | |
| 304 <div align="right"><a href="#top">Up</a></div> | |
| 305 <hr /><hr /> | |
| 306 <a NAME="createGlobalPluginsDir" ID="createGlobalPluginsDir"></a> | |
| 307 <h2>createGlobalPluginsDir</h2> | |
| 308 <b>createGlobalPluginsDir</b>(<i></i>) | |
| 309 <p> | |
| 310 Create the global plugins directory, if it doesn't exist. | |
| 311 </p> | |
| 312 <div align="right"><a href="#top">Up</a></div> | |
| 313 <hr /><hr /> | |
| 314 <a NAME="createInstallConfig" ID="createInstallConfig"></a> | |
| 315 <h2>createInstallConfig</h2> | |
| 316 <b>createInstallConfig</b>(<i></i>) | |
| 317 <p> | |
| 318 Create the installation config dictionary. | |
| 319 </p> | |
| 320 <div align="right"><a href="#top">Up</a></div> | |
| 321 <hr /><hr /> | |
| 322 <a NAME="createLinuxSpecifics" ID="createLinuxSpecifics"></a> | |
| 323 <h2>createLinuxSpecifics</h2> | |
| 324 <b>createLinuxSpecifics</b>(<i></i>) | |
| 325 <p> | |
| 326 Install Linux specific files. | |
| 327 </p> | |
| 328 <div align="right"><a href="#top">Up</a></div> | |
| 329 <hr /><hr /> | |
| 330 <a NAME="createMacAppBundle" ID="createMacAppBundle"></a> | |
| 331 <h2>createMacAppBundle</h2> | |
| 332 <b>createMacAppBundle</b>(<i>pydir</i>) | |
| 333 <p> | |
| 334 Create a Mac application bundle. | |
| 335 </p><dl> | |
| 336 <dt><i>pydir</i> (str)</dt> | |
| 337 <dd> | |
| 338 the name of the directory where the Python script will | |
| 339 eventually be installed | |
| 340 </dd> | |
| 341 </dl> | |
| 342 <div align="right"><a href="#top">Up</a></div> | |
| 343 <hr /><hr /> | |
| 344 <a NAME="createPyWrapper" ID="createPyWrapper"></a> | |
| 345 <h2>createPyWrapper</h2> | |
| 346 <b>createPyWrapper</b>(<i>pydir, wfile, isGuiScript=True</i>) | |
| 347 <p> | |
| 348 Create an executable wrapper for a Python script. | |
| 349 </p><dl> | |
| 350 <dt><i>pydir</i></dt> | |
| 351 <dd> | |
| 352 the name of the directory where the Python script will | |
| 353 eventually be installed (string) | |
| 354 </dd><dt><i>wfile</i></dt> | |
| 355 <dd> | |
| 356 the basename of the wrapper (string) | |
| 357 </dd><dt><i>isGuiScript</i></dt> | |
| 358 <dd> | |
| 359 flag indicating a wrapper script for a GUI | |
| 360 application (boolean) | |
| 361 </dd> | |
| 362 </dl><dl> | |
| 363 <dt>Returns:</dt> | |
| 364 <dd> | |
| 365 the platform specific name of the wrapper (string) | |
| 366 </dd> | |
| 367 </dl> | |
| 368 <div align="right"><a href="#top">Up</a></div> | |
| 369 <hr /><hr /> | |
| 370 <a NAME="createWindowsLinks" ID="createWindowsLinks"></a> | |
| 371 <h2>createWindowsLinks</h2> | |
| 372 <b>createWindowsLinks</b>(<i></i>) | |
| 373 <p> | |
| 374 Create Desktop and Start Menu links. | |
| 375 </p> | |
| 376 <div align="right"><a href="#top">Up</a></div> | |
| 377 <hr /><hr /> | |
| 378 <a NAME="createWindowsShortcut" ID="createWindowsShortcut"></a> | |
| 379 <h2>createWindowsShortcut</h2> | |
| 380 <b>createWindowsShortcut</b>(<i>linkPath, targetPath, iconPath</i>) | |
| 381 <p> | |
| 382 Create Windows shortcut. | |
| 383 </p><dl> | |
| 384 <dt><i>linkPath</i> (str)</dt> | |
| 385 <dd> | |
| 386 path of the shortcut file | |
| 387 </dd><dt><i>targetPath</i> (str)</dt> | |
| 388 <dd> | |
| 389 path the shortcut shall point to | |
| 390 </dd><dt><i>iconPath</i> (str)</dt> | |
| 391 <dd> | |
| 392 path of the icon file | |
| 393 </dd> | |
| 394 </dl> | |
| 395 <div align="right"><a href="#top">Up</a></div> | |
| 396 <hr /><hr /> | |
| 397 <a NAME="determinePyQtVariant" ID="determinePyQtVariant"></a> | |
| 398 <h2>determinePyQtVariant</h2> | |
| 399 <b>determinePyQtVariant</b>(<i></i>) | |
| 400 <p> | |
| 401 Module function to determine the PyQt variant to be used. | |
| 402 </p> | |
| 403 <div align="right"><a href="#top">Up</a></div> | |
| 404 <hr /><hr /> | |
| 405 <a NAME="doDependancyChecks" ID="doDependancyChecks"></a> | |
| 406 <h2>doDependancyChecks</h2> | |
| 407 <b>doDependancyChecks</b>(<i></i>) | |
| 408 <p> | |
| 409 Perform some dependency checks. | |
| 410 </p> | |
| 411 <div align="right"><a href="#top">Up</a></div> | |
| 412 <hr /><hr /> | |
| 413 <a NAME="exit" ID="exit"></a> | |
| 414 <h2>exit</h2> | |
| 415 <b>exit</b>(<i>rcode=0</i>) | |
| 416 <p> | |
| 417 Exit the install script. | |
| 418 </p><dl> | |
| 419 <dt><i>rcode</i></dt> | |
| 420 <dd> | |
| 421 result code to report back (integer) | |
| 422 </dd> | |
| 423 </dl> | |
| 424 <div align="right"><a href="#top">Up</a></div> | |
| 425 <hr /><hr /> | |
| 426 <a NAME="getWinregEntry" ID="getWinregEntry"></a> | |
| 427 <h2>getWinregEntry</h2> | |
| 428 <b>getWinregEntry</b>(<i>name, path</i>) | |
| 429 <p> | |
| 430 Function to get an entry from the Windows Registry. | |
| 431 </p><dl> | |
| 432 <dt><i>name</i> (str)</dt> | |
| 433 <dd> | |
| 434 variable name | |
| 435 </dd><dt><i>path</i> (str)</dt> | |
| 436 <dd> | |
| 437 registry path of the variable | |
| 438 </dd> | |
| 439 </dl><dl> | |
| 440 <dt>Returns:</dt> | |
| 441 <dd> | |
| 442 value of requested registry variable | |
| 443 </dd> | |
| 444 </dl><dl> | |
| 445 <dt>Return Type:</dt> | |
| 446 <dd> | |
| 447 any | |
| 448 </dd> | |
| 449 </dl> | |
| 450 <div align="right"><a href="#top">Up</a></div> | |
| 451 <hr /><hr /> | |
| 452 <a NAME="initGlobals" ID="initGlobals"></a> | |
| 453 <h2>initGlobals</h2> | |
| 454 <b>initGlobals</b>(<i></i>) | |
| 455 <p> | |
| 456 Module function to set the values of globals that need more than a | |
| 457 simple assignment. | |
| 458 </p> | |
| 459 <div align="right"><a href="#top">Up</a></div> | |
| 460 <hr /><hr /> | |
| 461 <a NAME="installEric" ID="installEric"></a> | |
| 462 <h2>installEric</h2> | |
| 463 <b>installEric</b>(<i></i>) | |
| 464 <p> | |
| 465 Actually perform the installation steps. | |
| 466 </p><dl> | |
| 467 <dt>Returns:</dt> | |
| 468 <dd> | |
| 469 result code (integer) | |
| 470 </dd> | |
| 471 </dl> | |
| 472 <div align="right"><a href="#top">Up</a></div> | |
| 473 <hr /><hr /> | |
| 474 <a NAME="main" ID="main"></a> | |
| 475 <h2>main</h2> | |
| 476 <b>main</b>(<i>argv</i>) | |
| 477 <p> | |
| 478 The main function of the script. | |
| 479 </p><dl> | |
| 480 <dt><i>argv</i> (list of str)</dt> | |
| 481 <dd> | |
| 482 list of command line arguments | |
| 483 </dd> | |
| 484 </dl> | |
| 485 <div align="right"><a href="#top">Up</a></div> | |
| 486 <hr /><hr /> | |
| 487 <a NAME="pipInstall" ID="pipInstall"></a> | |
| 488 <h2>pipInstall</h2> | |
| 489 <b>pipInstall</b>(<i>packageName, message</i>) | |
| 490 <p> | |
| 491 Install the given package via pip. | |
| 492 </p><dl> | |
| 493 <dt><i>packageName</i> (str)</dt> | |
| 494 <dd> | |
| 495 name of the package to be installed | |
| 496 </dd><dt><i>message</i> (str)</dt> | |
| 497 <dd> | |
| 498 message to be shown to the user | |
| 499 </dd> | |
| 500 </dl><dl> | |
| 501 <dt>Returns:</dt> | |
| 502 <dd> | |
| 503 flag indicating a successful installation | |
| 504 </dd> | |
| 505 </dl><dl> | |
| 506 <dt>Return Type:</dt> | |
| 507 <dd> | |
| 508 bool | |
| 509 </dd> | |
| 510 </dl> | |
| 511 <div align="right"><a href="#top">Up</a></div> | |
| 512 <hr /><hr /> | |
| 513 <a NAME="prepareInfoFile" ID="prepareInfoFile"></a> | |
| 514 <h2>prepareInfoFile</h2> | |
| 515 <b>prepareInfoFile</b>(<i>fileName</i>) | |
| 516 <p> | |
| 517 Function to prepare an Info.py file when installing from source. | |
| 518 </p><dl> | |
| 519 <dt><i>fileName</i></dt> | |
| 520 <dd> | |
| 521 name of the Python file containing the info (string) | |
| 522 </dd> | |
| 523 </dl> | |
| 524 <div align="right"><a href="#top">Up</a></div> | |
| 525 <hr /><hr /> | |
| 526 <a NAME="shutilCopy" ID="shutilCopy"></a> | |
| 527 <h2>shutilCopy</h2> | |
| 528 <b>shutilCopy</b>(<i>src, dst, perm=0o644</i>) | |
| 529 <p> | |
| 530 Wrapper function around shutil.copy() to ensure the permissions. | |
| 531 </p><dl> | |
| 532 <dt><i>src</i></dt> | |
| 533 <dd> | |
| 534 source file name (string) | |
| 535 </dd><dt><i>dst</i></dt> | |
| 536 <dd> | |
| 537 destination file name or directory name (string) | |
| 538 </dd><dt><i>perm=</i></dt> | |
| 539 <dd> | |
| 540 permissions to be set (integer) | |
| 541 </dd> | |
| 542 </dl> | |
| 543 <div align="right"><a href="#top">Up</a></div> | |
| 544 <hr /><hr /> | |
| 545 <a NAME="usage" ID="usage"></a> | |
| 546 <h2>usage</h2> | |
| 547 <b>usage</b>(<i>rcode=2</i>) | |
| 548 <p> | |
| 549 Display a usage message and exit. | |
| 550 </p><dl> | |
| 551 <dt><i>rcode</i></dt> | |
| 552 <dd> | |
| 553 the return code passed back to the calling process. | |
| 554 </dd> | |
| 555 </dl> | |
| 556 <div align="right"><a href="#top">Up</a></div> | |
| 557 <hr /><hr /> | |
| 558 <a NAME="windowsDesktopEntries" ID="windowsDesktopEntries"></a> | |
| 559 <h2>windowsDesktopEntries</h2> | |
| 560 <b>windowsDesktopEntries</b>(<i></i>) | |
| 561 <p> | |
| 562 Function to generate data for the Windows Desktop links. | |
| 563 </p><dl> | |
| 564 <dt>Returns:</dt> | |
| 565 <dd> | |
| 566 list of tuples containing the desktop link name, | |
| 567 the link target and the icon target | |
| 568 </dd> | |
| 569 </dl><dl> | |
| 570 <dt>Return Type:</dt> | |
| 571 <dd> | |
| 572 list of tuples of (str, str, str) | |
| 573 </dd> | |
| 574 </dl> | |
| 575 <div align="right"><a href="#top">Up</a></div> | |
| 576 <hr /><hr /> | |
| 577 <a NAME="windowsDesktopNames" ID="windowsDesktopNames"></a> | |
| 578 <h2>windowsDesktopNames</h2> | |
| 579 <b>windowsDesktopNames</b>(<i></i>) | |
| 580 <p> | |
| 581 Function to generate the link names for the Windows Desktop. | |
| 582 </p><dl> | |
| 583 <dt>Returns:</dt> | |
| 584 <dd> | |
| 585 list of desktop link names | |
| 586 </dd> | |
| 587 </dl><dl> | |
| 588 <dt>Return Type:</dt> | |
| 589 <dd> | |
| 590 list of str | |
| 591 </dd> | |
| 592 </dl> | |
| 593 <div align="right"><a href="#top">Up</a></div> | |
| 594 <hr /><hr /> | |
| 595 <a NAME="windowsProgramsEntry" ID="windowsProgramsEntry"></a> | |
| 596 <h2>windowsProgramsEntry</h2> | |
| 597 <b>windowsProgramsEntry</b>(<i></i>) | |
| 598 <p> | |
| 599 Function to generate the name of the Start Menu top entry. | |
| 600 </p><dl> | |
| 601 <dt>Returns:</dt> | |
| 602 <dd> | |
| 603 name of the Start Menu top entry | |
| 604 </dd> | |
| 605 </dl><dl> | |
| 606 <dt>Return Type:</dt> | |
| 607 <dd> | |
| 608 str | |
| 609 </dd> | |
| 610 </dl> | |
| 611 <div align="right"><a href="#top">Up</a></div> | |
| 612 <hr /><hr /> | |
| 613 <a NAME="wrapperNames" ID="wrapperNames"></a> | |
| 614 <h2>wrapperNames</h2> | |
| 615 <b>wrapperNames</b>(<i>dname, wfile</i>) | |
| 616 <p> | |
| 617 Create the platform specific names for the wrapper script. | |
| 618 </p><dl> | |
| 619 <dt><i>dname</i></dt> | |
| 620 <dd> | |
| 621 name of the directory to place the wrapper into | |
| 622 </dd><dt><i>wfile</i></dt> | |
| 623 <dd> | |
| 624 basename (without extension) of the wrapper script | |
| 625 </dd> | |
| 626 </dl><dl> | |
| 627 <dt>Returns:</dt> | |
| 628 <dd> | |
| 629 the names of the wrapper scripts | |
| 630 </dd> | |
| 631 </dl> | |
| 632 <div align="right"><a href="#top">Up</a></div> | |
| 633 <hr /> | |
| 634 </body></html> |
