Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/install.html

eric6/Documentation/Source/install.html

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

Mercurial Repository: eric

eric ide

mercurial