Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/install.html
src/eric7/Documentation/Source/install.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8660
- 1848e8e4b380
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>install</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>install</h1> | |
| 10 | |
| 11 <p> | |
| 12 Installation script for the eric IDE and all eric related tools. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>BlackLists</td></tr><tr><td>PlatformsBlackLists</td></tr><tr><td>apisDir</td></tr><tr><td>cfg</td></tr><tr><td>configLength</td></tr><tr><td>configName</td></tr><tr><td>createInstallInfoFile</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>eric7SourceDir</td></tr><tr><td>forceCleanDesktopLinks</td></tr><tr><td>ignorePyqt6Tools</td></tr><tr><td>installApis</td></tr><tr><td>installCwd</td></tr><tr><td>installInfo</td></tr><tr><td>installInfoName</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>sourceDir</td></tr><tr><td>verbose</td></tr><tr><td>yes2All</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 <tr><td>None</td></tr> | |
| 23 </table> | |
| 24 <h3>Functions</h3> | |
| 25 | |
| 26 <table> | |
| 27 | |
| 28 <tr> | |
| 29 <td><a href="#__pyName">__pyName</a></td> | |
| 30 <td>Local function to create the Python source file name for the compiled .ui file.</td> | |
| 31 </tr> | |
| 32 <tr> | |
| 33 <td><a href="#cleanUp">cleanUp</a></td> | |
| 34 <td>Uninstall the old eric files.</td> | |
| 35 </tr> | |
| 36 <tr> | |
| 37 <td><a href="#cleanUpLinuxSpecifics">cleanUpLinuxSpecifics</a></td> | |
| 38 <td>Clean up Linux specific files.</td> | |
| 39 </tr> | |
| 40 <tr> | |
| 41 <td><a href="#cleanUpMacAppBundle">cleanUpMacAppBundle</a></td> | |
| 42 <td>Uninstall the macOS application bundle.</td> | |
| 43 </tr> | |
| 44 <tr> | |
| 45 <td><a href="#cleanUpWindowsLinks">cleanUpWindowsLinks</a></td> | |
| 46 <td>Clean up the Desktop and Start Menu entries for Windows.</td> | |
| 47 </tr> | |
| 48 <tr> | |
| 49 <td><a href="#cleanupSource">cleanupSource</a></td> | |
| 50 <td>Cleanup the sources directory to get rid of leftover files and directories.</td> | |
| 51 </tr> | |
| 52 <tr> | |
| 53 <td><a href="#compileUiFiles">compileUiFiles</a></td> | |
| 54 <td>Compile the .ui files to Python sources.</td> | |
| 55 </tr> | |
| 56 <tr> | |
| 57 <td><a href="#copyAppStreamFile">copyAppStreamFile</a></td> | |
| 58 <td>Modify an appstream file and write it to its destination.</td> | |
| 59 </tr> | |
| 60 <tr> | |
| 61 <td><a href="#copyDesktopFile">copyDesktopFile</a></td> | |
| 62 <td>Modify a desktop file and write it to its destination.</td> | |
| 63 </tr> | |
| 64 <tr> | |
| 65 <td><a href="#copyToFile">copyToFile</a></td> | |
| 66 <td>Copy a string to a file.</td> | |
| 67 </tr> | |
| 68 <tr> | |
| 69 <td><a href="#copyTree">copyTree</a></td> | |
| 70 <td>Copy Python, translation, documentation, wizards configuration, designer template files and DTDs of a directory tree.</td> | |
| 71 </tr> | |
| 72 <tr> | |
| 73 <td><a href="#createConfig">createConfig</a></td> | |
| 74 <td>Create a config file with the respective config entries.</td> | |
| 75 </tr> | |
| 76 <tr> | |
| 77 <td><a href="#createGlobalPluginsDir">createGlobalPluginsDir</a></td> | |
| 78 <td>Create the global plugins directory, if it doesn't exist.</td> | |
| 79 </tr> | |
| 80 <tr> | |
| 81 <td><a href="#createInstallConfig">createInstallConfig</a></td> | |
| 82 <td>Create the installation config dictionary.</td> | |
| 83 </tr> | |
| 84 <tr> | |
| 85 <td><a href="#createInstallInfo">createInstallInfo</a></td> | |
| 86 <td>Record information about the way eric was installed.</td> | |
| 87 </tr> | |
| 88 <tr> | |
| 89 <td><a href="#createLinuxSpecifics">createLinuxSpecifics</a></td> | |
| 90 <td>Install Linux specific files.</td> | |
| 91 </tr> | |
| 92 <tr> | |
| 93 <td><a href="#createMacAppBundle">createMacAppBundle</a></td> | |
| 94 <td>Create a Mac application bundle.</td> | |
| 95 </tr> | |
| 96 <tr> | |
| 97 <td><a href="#createPyWrapper">createPyWrapper</a></td> | |
| 98 <td>Create an executable wrapper for a Python script.</td> | |
| 99 </tr> | |
| 100 <tr> | |
| 101 <td><a href="#createWindowsLinks">createWindowsLinks</a></td> | |
| 102 <td>Create Desktop and Start Menu links.</td> | |
| 103 </tr> | |
| 104 <tr> | |
| 105 <td><a href="#createWindowsShortcut">createWindowsShortcut</a></td> | |
| 106 <td>Create Windows shortcut.</td> | |
| 107 </tr> | |
| 108 <tr> | |
| 109 <td><a href="#doDependancyChecks">doDependancyChecks</a></td> | |
| 110 <td>Perform some dependency checks.</td> | |
| 111 </tr> | |
| 112 <tr> | |
| 113 <td><a href="#exit">exit</a></td> | |
| 114 <td>Exit the install script.</td> | |
| 115 </tr> | |
| 116 <tr> | |
| 117 <td><a href="#getWinregEntry">getWinregEntry</a></td> | |
| 118 <td>Function to get an entry from the Windows Registry.</td> | |
| 119 </tr> | |
| 120 <tr> | |
| 121 <td><a href="#initGlobals">initGlobals</a></td> | |
| 122 <td>Module function to set the values of globals that need more than a simple assignment.</td> | |
| 123 </tr> | |
| 124 <tr> | |
| 125 <td><a href="#installEric">installEric</a></td> | |
| 126 <td>Actually perform the installation steps.</td> | |
| 127 </tr> | |
| 128 <tr> | |
| 129 <td><a href="#isPipOutdated">isPipOutdated</a></td> | |
| 130 <td>Check, if pip is outdated.</td> | |
| 131 </tr> | |
| 132 <tr> | |
| 133 <td><a href="#main">main</a></td> | |
| 134 <td>The main function of the script.</td> | |
| 135 </tr> | |
| 136 <tr> | |
| 137 <td><a href="#pipInstall">pipInstall</a></td> | |
| 138 <td>Install the given package via pip.</td> | |
| 139 </tr> | |
| 140 <tr> | |
| 141 <td><a href="#prepareInfoFile">prepareInfoFile</a></td> | |
| 142 <td>Function to prepare an Info.py file when installing from source.</td> | |
| 143 </tr> | |
| 144 <tr> | |
| 145 <td><a href="#shutilCopy">shutilCopy</a></td> | |
| 146 <td>Wrapper function around shutil.copy() to ensure the permissions.</td> | |
| 147 </tr> | |
| 148 <tr> | |
| 149 <td><a href="#updatePip">updatePip</a></td> | |
| 150 <td>Update the installed pip package.</td> | |
| 151 </tr> | |
| 152 <tr> | |
| 153 <td><a href="#usage">usage</a></td> | |
| 154 <td>Display a usage message and exit.</td> | |
| 155 </tr> | |
| 156 <tr> | |
| 157 <td><a href="#versionToStr">versionToStr</a></td> | |
| 158 <td>Function to convert a version number into a version string.</td> | |
| 159 </tr> | |
| 160 <tr> | |
| 161 <td><a href="#windowsDesktopEntries">windowsDesktopEntries</a></td> | |
| 162 <td>Function to generate data for the Windows Desktop links.</td> | |
| 163 </tr> | |
| 164 <tr> | |
| 165 <td><a href="#windowsDesktopNames">windowsDesktopNames</a></td> | |
| 166 <td>Function to generate the link names for the Windows Desktop.</td> | |
| 167 </tr> | |
| 168 <tr> | |
| 169 <td><a href="#windowsProgramsEntry">windowsProgramsEntry</a></td> | |
| 170 <td>Function to generate the name of the Start Menu top entry.</td> | |
| 171 </tr> | |
| 172 <tr> | |
| 173 <td><a href="#wrapperNames">wrapperNames</a></td> | |
| 174 <td>Create the platform specific names for the wrapper script.</td> | |
| 175 </tr> | |
| 176 </table> | |
| 177 <hr /> | |
| 178 <hr /> | |
| 179 <a NAME="__pyName" ID="__pyName"></a> | |
| 180 <h2>__pyName</h2> | |
| 181 <b>__pyName</b>(<i>py_dir, py_file</i>) | |
| 182 | |
| 183 <p> | |
| 184 Local function to create the Python source file name for the compiled | |
| 185 .ui file. | |
| 186 </p> | |
| 187 <dl> | |
| 188 | |
| 189 <dt><i>py_dir</i></dt> | |
| 190 <dd> | |
| 191 suggested name of the directory (string) | |
| 192 </dd> | |
| 193 <dt><i>py_file</i></dt> | |
| 194 <dd> | |
| 195 suggested name for the compile source file (string) | |
| 196 </dd> | |
| 197 </dl> | |
| 198 <dl> | |
| 199 <dt>Return:</dt> | |
| 200 <dd> | |
| 201 tuple of directory name (string) and source file name (string) | |
| 202 </dd> | |
| 203 </dl> | |
| 204 <div align="right"><a href="#top">Up</a></div> | |
| 205 <hr /> | |
| 206 <hr /> | |
| 207 <a NAME="cleanUp" ID="cleanUp"></a> | |
| 208 <h2>cleanUp</h2> | |
| 209 <b>cleanUp</b>(<i></i>) | |
| 210 | |
| 211 <p> | |
| 212 Uninstall the old eric files. | |
| 213 </p> | |
| 214 <div align="right"><a href="#top">Up</a></div> | |
| 215 <hr /> | |
| 216 <hr /> | |
| 217 <a NAME="cleanUpLinuxSpecifics" ID="cleanUpLinuxSpecifics"></a> | |
| 218 <h2>cleanUpLinuxSpecifics</h2> | |
| 219 <b>cleanUpLinuxSpecifics</b>(<i></i>) | |
| 220 | |
| 221 <p> | |
| 222 Clean up Linux specific files. | |
| 223 </p> | |
| 224 <div align="right"><a href="#top">Up</a></div> | |
| 225 <hr /> | |
| 226 <hr /> | |
| 227 <a NAME="cleanUpMacAppBundle" ID="cleanUpMacAppBundle"></a> | |
| 228 <h2>cleanUpMacAppBundle</h2> | |
| 229 <b>cleanUpMacAppBundle</b>(<i></i>) | |
| 230 | |
| 231 <p> | |
| 232 Uninstall the macOS application bundle. | |
| 233 </p> | |
| 234 <div align="right"><a href="#top">Up</a></div> | |
| 235 <hr /> | |
| 236 <hr /> | |
| 237 <a NAME="cleanUpWindowsLinks" ID="cleanUpWindowsLinks"></a> | |
| 238 <h2>cleanUpWindowsLinks</h2> | |
| 239 <b>cleanUpWindowsLinks</b>(<i></i>) | |
| 240 | |
| 241 <p> | |
| 242 Clean up the Desktop and Start Menu entries for Windows. | |
| 243 </p> | |
| 244 <div align="right"><a href="#top">Up</a></div> | |
| 245 <hr /> | |
| 246 <hr /> | |
| 247 <a NAME="cleanupSource" ID="cleanupSource"></a> | |
| 248 <h2>cleanupSource</h2> | |
| 249 <b>cleanupSource</b>(<i>dirName</i>) | |
| 250 | |
| 251 <p> | |
| 252 Cleanup the sources directory to get rid of leftover files | |
| 253 and directories. | |
| 254 </p> | |
| 255 <dl> | |
| 256 | |
| 257 <dt><i>dirName</i></dt> | |
| 258 <dd> | |
| 259 name of the directory to prune (string) | |
| 260 </dd> | |
| 261 </dl> | |
| 262 <div align="right"><a href="#top">Up</a></div> | |
| 263 <hr /> | |
| 264 <hr /> | |
| 265 <a NAME="compileUiFiles" ID="compileUiFiles"></a> | |
| 266 <h2>compileUiFiles</h2> | |
| 267 <b>compileUiFiles</b>(<i></i>) | |
| 268 | |
| 269 <p> | |
| 270 Compile the .ui files to Python sources. | |
| 271 </p> | |
| 272 <div align="right"><a href="#top">Up</a></div> | |
| 273 <hr /> | |
| 274 <hr /> | |
| 275 <a NAME="copyAppStreamFile" ID="copyAppStreamFile"></a> | |
| 276 <h2>copyAppStreamFile</h2> | |
| 277 <b>copyAppStreamFile</b>(<i>src, dst</i>) | |
| 278 | |
| 279 <p> | |
| 280 Modify an appstream file and write it to its destination. | |
| 281 </p> | |
| 282 <dl> | |
| 283 | |
| 284 <dt><i>src</i></dt> | |
| 285 <dd> | |
| 286 source file name (string) | |
| 287 </dd> | |
| 288 <dt><i>dst</i></dt> | |
| 289 <dd> | |
| 290 destination file name (string) | |
| 291 </dd> | |
| 292 </dl> | |
| 293 <div align="right"><a href="#top">Up</a></div> | |
| 294 <hr /> | |
| 295 <hr /> | |
| 296 <a NAME="copyDesktopFile" ID="copyDesktopFile"></a> | |
| 297 <h2>copyDesktopFile</h2> | |
| 298 <b>copyDesktopFile</b>(<i>src, dst</i>) | |
| 299 | |
| 300 <p> | |
| 301 Modify a desktop file and write it to its destination. | |
| 302 </p> | |
| 303 <dl> | |
| 304 | |
| 305 <dt><i>src</i></dt> | |
| 306 <dd> | |
| 307 source file name (string) | |
| 308 </dd> | |
| 309 <dt><i>dst</i></dt> | |
| 310 <dd> | |
| 311 destination file name (string) | |
| 312 </dd> | |
| 313 </dl> | |
| 314 <div align="right"><a href="#top">Up</a></div> | |
| 315 <hr /> | |
| 316 <hr /> | |
| 317 <a NAME="copyToFile" ID="copyToFile"></a> | |
| 318 <h2>copyToFile</h2> | |
| 319 <b>copyToFile</b>(<i>name, text</i>) | |
| 320 | |
| 321 <p> | |
| 322 Copy a string to a file. | |
| 323 </p> | |
| 324 <dl> | |
| 325 | |
| 326 <dt><i>name</i></dt> | |
| 327 <dd> | |
| 328 the name of the file. | |
| 329 </dd> | |
| 330 <dt><i>text</i></dt> | |
| 331 <dd> | |
| 332 the contents to copy to the file. | |
| 333 </dd> | |
| 334 </dl> | |
| 335 <div align="right"><a href="#top">Up</a></div> | |
| 336 <hr /> | |
| 337 <hr /> | |
| 338 <a NAME="copyTree" ID="copyTree"></a> | |
| 339 <h2>copyTree</h2> | |
| 340 <b>copyTree</b>(<i>src, dst, filters, excludeDirs=None, excludePatterns=None</i>) | |
| 341 | |
| 342 <p> | |
| 343 Copy Python, translation, documentation, wizards configuration, | |
| 344 designer template files and DTDs of a directory tree. | |
| 345 </p> | |
| 346 <dl> | |
| 347 | |
| 348 <dt><i>src</i></dt> | |
| 349 <dd> | |
| 350 name of the source directory | |
| 351 </dd> | |
| 352 <dt><i>dst</i></dt> | |
| 353 <dd> | |
| 354 name of the destination directory | |
| 355 </dd> | |
| 356 <dt><i>filters</i></dt> | |
| 357 <dd> | |
| 358 list of filter pattern determining the files to be copied | |
| 359 </dd> | |
| 360 <dt><i>excludeDirs</i></dt> | |
| 361 <dd> | |
| 362 list of (sub)directories to exclude from copying | |
| 363 </dd> | |
| 364 <dt><i>excludePatterns</i></dt> | |
| 365 <dd> | |
| 366 list of filter pattern determining the files to | |
| 367 be skipped | |
| 368 </dd> | |
| 369 </dl> | |
| 370 <div align="right"><a href="#top">Up</a></div> | |
| 371 <hr /> | |
| 372 <hr /> | |
| 373 <a NAME="createConfig" ID="createConfig"></a> | |
| 374 <h2>createConfig</h2> | |
| 375 <b>createConfig</b>(<i></i>) | |
| 376 | |
| 377 <p> | |
| 378 Create a config file with the respective config entries. | |
| 379 </p> | |
| 380 <div align="right"><a href="#top">Up</a></div> | |
| 381 <hr /> | |
| 382 <hr /> | |
| 383 <a NAME="createGlobalPluginsDir" ID="createGlobalPluginsDir"></a> | |
| 384 <h2>createGlobalPluginsDir</h2> | |
| 385 <b>createGlobalPluginsDir</b>(<i></i>) | |
| 386 | |
| 387 <p> | |
| 388 Create the global plugins directory, if it doesn't exist. | |
| 389 </p> | |
| 390 <div align="right"><a href="#top">Up</a></div> | |
| 391 <hr /> | |
| 392 <hr /> | |
| 393 <a NAME="createInstallConfig" ID="createInstallConfig"></a> | |
| 394 <h2>createInstallConfig</h2> | |
| 395 <b>createInstallConfig</b>(<i></i>) | |
| 396 | |
| 397 <p> | |
| 398 Create the installation config dictionary. | |
| 399 </p> | |
| 400 <div align="right"><a href="#top">Up</a></div> | |
| 401 <hr /> | |
| 402 <hr /> | |
| 403 <a NAME="createInstallInfo" ID="createInstallInfo"></a> | |
| 404 <h2>createInstallInfo</h2> | |
| 405 <b>createInstallInfo</b>(<i></i>) | |
| 406 | |
| 407 <p> | |
| 408 Record information about the way eric was installed. | |
| 409 </p> | |
| 410 <div align="right"><a href="#top">Up</a></div> | |
| 411 <hr /> | |
| 412 <hr /> | |
| 413 <a NAME="createLinuxSpecifics" ID="createLinuxSpecifics"></a> | |
| 414 <h2>createLinuxSpecifics</h2> | |
| 415 <b>createLinuxSpecifics</b>(<i></i>) | |
| 416 | |
| 417 <p> | |
| 418 Install Linux specific files. | |
| 419 </p> | |
| 420 <div align="right"><a href="#top">Up</a></div> | |
| 421 <hr /> | |
| 422 <hr /> | |
| 423 <a NAME="createMacAppBundle" ID="createMacAppBundle"></a> | |
| 424 <h2>createMacAppBundle</h2> | |
| 425 <b>createMacAppBundle</b>(<i>pydir</i>) | |
| 426 | |
| 427 <p> | |
| 428 Create a Mac application bundle. | |
| 429 </p> | |
| 430 <dl> | |
| 431 | |
| 432 <dt><i>pydir</i> (str)</dt> | |
| 433 <dd> | |
| 434 the name of the directory where the Python script will | |
| 435 eventually be installed | |
| 436 </dd> | |
| 437 </dl> | |
| 438 <div align="right"><a href="#top">Up</a></div> | |
| 439 <hr /> | |
| 440 <hr /> | |
| 441 <a NAME="createPyWrapper" ID="createPyWrapper"></a> | |
| 442 <h2>createPyWrapper</h2> | |
| 443 <b>createPyWrapper</b>(<i>pydir, wfile, saveDir, isGuiScript=True</i>) | |
| 444 | |
| 445 <p> | |
| 446 Create an executable wrapper for a Python script. | |
| 447 </p> | |
| 448 <dl> | |
| 449 | |
| 450 <dt><i>pydir</i></dt> | |
| 451 <dd> | |
| 452 the name of the directory where the Python script will | |
| 453 eventually be installed (string) | |
| 454 </dd> | |
| 455 <dt><i>wfile</i></dt> | |
| 456 <dd> | |
| 457 the basename of the wrapper (string) | |
| 458 </dd> | |
| 459 <dt><i>saveDir</i></dt> | |
| 460 <dd> | |
| 461 directory to save the file into (string) | |
| 462 </dd> | |
| 463 <dt><i>isGuiScript</i></dt> | |
| 464 <dd> | |
| 465 flag indicating a wrapper script for a GUI | |
| 466 application (boolean) | |
| 467 </dd> | |
| 468 </dl> | |
| 469 <dl> | |
| 470 <dt>Return:</dt> | |
| 471 <dd> | |
| 472 the platform specific name of the wrapper (string) | |
| 473 </dd> | |
| 474 </dl> | |
| 475 <div align="right"><a href="#top">Up</a></div> | |
| 476 <hr /> | |
| 477 <hr /> | |
| 478 <a NAME="createWindowsLinks" ID="createWindowsLinks"></a> | |
| 479 <h2>createWindowsLinks</h2> | |
| 480 <b>createWindowsLinks</b>(<i></i>) | |
| 481 | |
| 482 <p> | |
| 483 Create Desktop and Start Menu links. | |
| 484 </p> | |
| 485 <div align="right"><a href="#top">Up</a></div> | |
| 486 <hr /> | |
| 487 <hr /> | |
| 488 <a NAME="createWindowsShortcut" ID="createWindowsShortcut"></a> | |
| 489 <h2>createWindowsShortcut</h2> | |
| 490 <b>createWindowsShortcut</b>(<i>linkPath, targetPath, iconPath</i>) | |
| 491 | |
| 492 <p> | |
| 493 Create Windows shortcut. | |
| 494 </p> | |
| 495 <dl> | |
| 496 | |
| 497 <dt><i>linkPath</i> (str)</dt> | |
| 498 <dd> | |
| 499 path of the shortcut file | |
| 500 </dd> | |
| 501 <dt><i>targetPath</i> (str)</dt> | |
| 502 <dd> | |
| 503 path the shortcut shall point to | |
| 504 </dd> | |
| 505 <dt><i>iconPath</i> (str)</dt> | |
| 506 <dd> | |
| 507 path of the icon file | |
| 508 </dd> | |
| 509 </dl> | |
| 510 <div align="right"><a href="#top">Up</a></div> | |
| 511 <hr /> | |
| 512 <hr /> | |
| 513 <a NAME="doDependancyChecks" ID="doDependancyChecks"></a> | |
| 514 <h2>doDependancyChecks</h2> | |
| 515 <b>doDependancyChecks</b>(<i></i>) | |
| 516 | |
| 517 <p> | |
| 518 Perform some dependency checks. | |
| 519 </p> | |
| 520 <div align="right"><a href="#top">Up</a></div> | |
| 521 <hr /> | |
| 522 <hr /> | |
| 523 <a NAME="exit" ID="exit"></a> | |
| 524 <h2>exit</h2> | |
| 525 <b>exit</b>(<i>rcode=0</i>) | |
| 526 | |
| 527 <p> | |
| 528 Exit the install script. | |
| 529 </p> | |
| 530 <dl> | |
| 531 | |
| 532 <dt><i>rcode</i></dt> | |
| 533 <dd> | |
| 534 result code to report back (integer) | |
| 535 </dd> | |
| 536 </dl> | |
| 537 <div align="right"><a href="#top">Up</a></div> | |
| 538 <hr /> | |
| 539 <hr /> | |
| 540 <a NAME="getWinregEntry" ID="getWinregEntry"></a> | |
| 541 <h2>getWinregEntry</h2> | |
| 542 <b>getWinregEntry</b>(<i>name, path</i>) | |
| 543 | |
| 544 <p> | |
| 545 Function to get an entry from the Windows Registry. | |
| 546 </p> | |
| 547 <dl> | |
| 548 | |
| 549 <dt><i>name</i> (str)</dt> | |
| 550 <dd> | |
| 551 variable name | |
| 552 </dd> | |
| 553 <dt><i>path</i> (str)</dt> | |
| 554 <dd> | |
| 555 registry path of the variable | |
| 556 </dd> | |
| 557 </dl> | |
| 558 <dl> | |
| 559 <dt>Return:</dt> | |
| 560 <dd> | |
| 561 value of requested registry variable | |
| 562 </dd> | |
| 563 </dl> | |
| 564 <dl> | |
| 565 <dt>Return Type:</dt> | |
| 566 <dd> | |
| 567 any | |
| 568 </dd> | |
| 569 </dl> | |
| 570 <div align="right"><a href="#top">Up</a></div> | |
| 571 <hr /> | |
| 572 <hr /> | |
| 573 <a NAME="initGlobals" ID="initGlobals"></a> | |
| 574 <h2>initGlobals</h2> | |
| 575 <b>initGlobals</b>(<i></i>) | |
| 576 | |
| 577 <p> | |
| 578 Module function to set the values of globals that need more than a | |
| 579 simple assignment. | |
| 580 </p> | |
| 581 <div align="right"><a href="#top">Up</a></div> | |
| 582 <hr /> | |
| 583 <hr /> | |
| 584 <a NAME="installEric" ID="installEric"></a> | |
| 585 <h2>installEric</h2> | |
| 586 <b>installEric</b>(<i></i>) | |
| 587 | |
| 588 <p> | |
| 589 Actually perform the installation steps. | |
| 590 </p> | |
| 591 <dl> | |
| 592 <dt>Return:</dt> | |
| 593 <dd> | |
| 594 result code (integer) | |
| 595 </dd> | |
| 596 </dl> | |
| 597 <div align="right"><a href="#top">Up</a></div> | |
| 598 <hr /> | |
| 599 <hr /> | |
| 600 <a NAME="isPipOutdated" ID="isPipOutdated"></a> | |
| 601 <h2>isPipOutdated</h2> | |
| 602 <b>isPipOutdated</b>(<i></i>) | |
| 603 | |
| 604 <p> | |
| 605 Check, if pip is outdated. | |
| 606 </p> | |
| 607 <dl> | |
| 608 <dt>Return:</dt> | |
| 609 <dd> | |
| 610 flag indicating an outdated pip | |
| 611 </dd> | |
| 612 </dl> | |
| 613 <dl> | |
| 614 <dt>Return Type:</dt> | |
| 615 <dd> | |
| 616 bool | |
| 617 </dd> | |
| 618 </dl> | |
| 619 <div align="right"><a href="#top">Up</a></div> | |
| 620 <hr /> | |
| 621 <hr /> | |
| 622 <a NAME="main" ID="main"></a> | |
| 623 <h2>main</h2> | |
| 624 <b>main</b>(<i>argv</i>) | |
| 625 | |
| 626 <p> | |
| 627 The main function of the script. | |
| 628 </p> | |
| 629 <dl> | |
| 630 | |
| 631 <dt><i>argv</i> (list of str)</dt> | |
| 632 <dd> | |
| 633 list of command line arguments | |
| 634 </dd> | |
| 635 </dl> | |
| 636 <div align="right"><a href="#top">Up</a></div> | |
| 637 <hr /> | |
| 638 <hr /> | |
| 639 <a NAME="pipInstall" ID="pipInstall"></a> | |
| 640 <h2>pipInstall</h2> | |
| 641 <b>pipInstall</b>(<i>packageName, message, force=True</i>) | |
| 642 | |
| 643 <p> | |
| 644 Install the given package via pip. | |
| 645 </p> | |
| 646 <dl> | |
| 647 | |
| 648 <dt><i>packageName</i> (str)</dt> | |
| 649 <dd> | |
| 650 name of the package to be installed | |
| 651 </dd> | |
| 652 <dt><i>message</i> (str)</dt> | |
| 653 <dd> | |
| 654 message to be shown to the user | |
| 655 </dd> | |
| 656 <dt><i>force</i> (bool)</dt> | |
| 657 <dd> | |
| 658 flag indicating to perform the installation | |
| 659 without asking the user | |
| 660 </dd> | |
| 661 </dl> | |
| 662 <dl> | |
| 663 <dt>Return:</dt> | |
| 664 <dd> | |
| 665 flag indicating a successful installation | |
| 666 </dd> | |
| 667 </dl> | |
| 668 <dl> | |
| 669 <dt>Return Type:</dt> | |
| 670 <dd> | |
| 671 bool | |
| 672 </dd> | |
| 673 </dl> | |
| 674 <div align="right"><a href="#top">Up</a></div> | |
| 675 <hr /> | |
| 676 <hr /> | |
| 677 <a NAME="prepareInfoFile" ID="prepareInfoFile"></a> | |
| 678 <h2>prepareInfoFile</h2> | |
| 679 <b>prepareInfoFile</b>(<i>fileName</i>) | |
| 680 | |
| 681 <p> | |
| 682 Function to prepare an Info.py file when installing from source. | |
| 683 </p> | |
| 684 <dl> | |
| 685 | |
| 686 <dt><i>fileName</i></dt> | |
| 687 <dd> | |
| 688 name of the Python file containing the info (string) | |
| 689 </dd> | |
| 690 </dl> | |
| 691 <div align="right"><a href="#top">Up</a></div> | |
| 692 <hr /> | |
| 693 <hr /> | |
| 694 <a NAME="shutilCopy" ID="shutilCopy"></a> | |
| 695 <h2>shutilCopy</h2> | |
| 696 <b>shutilCopy</b>(<i>src, dst, perm=0o644</i>) | |
| 697 | |
| 698 <p> | |
| 699 Wrapper function around shutil.copy() to ensure the permissions. | |
| 700 </p> | |
| 701 <dl> | |
| 702 | |
| 703 <dt><i>src</i></dt> | |
| 704 <dd> | |
| 705 source file name (string) | |
| 706 </dd> | |
| 707 <dt><i>dst</i></dt> | |
| 708 <dd> | |
| 709 destination file name or directory name (string) | |
| 710 </dd> | |
| 711 <dt><i>perm</i></dt> | |
| 712 <dd> | |
| 713 permissions to be set (integer) | |
| 714 </dd> | |
| 715 </dl> | |
| 716 <div align="right"><a href="#top">Up</a></div> | |
| 717 <hr /> | |
| 718 <hr /> | |
| 719 <a NAME="updatePip" ID="updatePip"></a> | |
| 720 <h2>updatePip</h2> | |
| 721 <b>updatePip</b>(<i></i>) | |
| 722 | |
| 723 <p> | |
| 724 Update the installed pip package. | |
| 725 </p> | |
| 726 <div align="right"><a href="#top">Up</a></div> | |
| 727 <hr /> | |
| 728 <hr /> | |
| 729 <a NAME="usage" ID="usage"></a> | |
| 730 <h2>usage</h2> | |
| 731 <b>usage</b>(<i>rcode=2</i>) | |
| 732 | |
| 733 <p> | |
| 734 Display a usage message and exit. | |
| 735 </p> | |
| 736 <dl> | |
| 737 | |
| 738 <dt><i>rcode</i></dt> | |
| 739 <dd> | |
| 740 the return code passed back to the calling process. | |
| 741 </dd> | |
| 742 </dl> | |
| 743 <div align="right"><a href="#top">Up</a></div> | |
| 744 <hr /> | |
| 745 <hr /> | |
| 746 <a NAME="versionToStr" ID="versionToStr"></a> | |
| 747 <h2>versionToStr</h2> | |
| 748 <b>versionToStr</b>(<i>version</i>) | |
| 749 | |
| 750 <p> | |
| 751 Function to convert a version number into a version string. | |
| 752 </p> | |
| 753 <dl> | |
| 754 | |
| 755 <dt><i>version</i> (int)</dt> | |
| 756 <dd> | |
| 757 version number to convert | |
| 758 </dd> | |
| 759 </dl> | |
| 760 <dl> | |
| 761 <dt>Return:</dt> | |
| 762 <dd> | |
| 763 version string | |
| 764 </dd> | |
| 765 </dl> | |
| 766 <dl> | |
| 767 <dt>Return Type:</dt> | |
| 768 <dd> | |
| 769 str | |
| 770 </dd> | |
| 771 </dl> | |
| 772 <div align="right"><a href="#top">Up</a></div> | |
| 773 <hr /> | |
| 774 <hr /> | |
| 775 <a NAME="windowsDesktopEntries" ID="windowsDesktopEntries"></a> | |
| 776 <h2>windowsDesktopEntries</h2> | |
| 777 <b>windowsDesktopEntries</b>(<i></i>) | |
| 778 | |
| 779 <p> | |
| 780 Function to generate data for the Windows Desktop links. | |
| 781 </p> | |
| 782 <dl> | |
| 783 <dt>Return:</dt> | |
| 784 <dd> | |
| 785 list of tuples containing the desktop link name, | |
| 786 the link target and the icon target | |
| 787 </dd> | |
| 788 </dl> | |
| 789 <dl> | |
| 790 <dt>Return Type:</dt> | |
| 791 <dd> | |
| 792 list of tuples of (str, str, str) | |
| 793 </dd> | |
| 794 </dl> | |
| 795 <div align="right"><a href="#top">Up</a></div> | |
| 796 <hr /> | |
| 797 <hr /> | |
| 798 <a NAME="windowsDesktopNames" ID="windowsDesktopNames"></a> | |
| 799 <h2>windowsDesktopNames</h2> | |
| 800 <b>windowsDesktopNames</b>(<i></i>) | |
| 801 | |
| 802 <p> | |
| 803 Function to generate the link names for the Windows Desktop. | |
| 804 </p> | |
| 805 <dl> | |
| 806 <dt>Return:</dt> | |
| 807 <dd> | |
| 808 list of desktop link names | |
| 809 </dd> | |
| 810 </dl> | |
| 811 <dl> | |
| 812 <dt>Return Type:</dt> | |
| 813 <dd> | |
| 814 list of str | |
| 815 </dd> | |
| 816 </dl> | |
| 817 <div align="right"><a href="#top">Up</a></div> | |
| 818 <hr /> | |
| 819 <hr /> | |
| 820 <a NAME="windowsProgramsEntry" ID="windowsProgramsEntry"></a> | |
| 821 <h2>windowsProgramsEntry</h2> | |
| 822 <b>windowsProgramsEntry</b>(<i></i>) | |
| 823 | |
| 824 <p> | |
| 825 Function to generate the name of the Start Menu top entry. | |
| 826 </p> | |
| 827 <dl> | |
| 828 <dt>Return:</dt> | |
| 829 <dd> | |
| 830 name of the Start Menu top entry | |
| 831 </dd> | |
| 832 </dl> | |
| 833 <dl> | |
| 834 <dt>Return Type:</dt> | |
| 835 <dd> | |
| 836 str | |
| 837 </dd> | |
| 838 </dl> | |
| 839 <div align="right"><a href="#top">Up</a></div> | |
| 840 <hr /> | |
| 841 <hr /> | |
| 842 <a NAME="wrapperNames" ID="wrapperNames"></a> | |
| 843 <h2>wrapperNames</h2> | |
| 844 <b>wrapperNames</b>(<i>dname, wfile</i>) | |
| 845 | |
| 846 <p> | |
| 847 Create the platform specific names for the wrapper script. | |
| 848 </p> | |
| 849 <dl> | |
| 850 | |
| 851 <dt><i>dname</i></dt> | |
| 852 <dd> | |
| 853 name of the directory to place the wrapper into | |
| 854 </dd> | |
| 855 <dt><i>wfile</i></dt> | |
| 856 <dd> | |
| 857 basename (without extension) of the wrapper script | |
| 858 </dd> | |
| 859 </dl> | |
| 860 <dl> | |
| 861 <dt>Return:</dt> | |
| 862 <dd> | |
| 863 the names of the wrapper scripts | |
| 864 </dd> | |
| 865 </dl> | |
| 866 <div align="right"><a href="#top">Up</a></div> | |
| 867 <hr /> | |
| 868 </body></html> |
