Updated source docu.

Sun, 21 Apr 2019 15:10:54 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sun, 21 Apr 2019 15:10:54 +0200
changeset 6967
29bf199c5e9b
parent 6966
7f529a3007b0
child 6968
c634f51e40ec

Updated source docu.

eric6/APIs/Python3/eric6.api file | annotate | diff | comparison | revisions
eric6/Documentation/Help/source.qch file | annotate | diff | comparison | revisions
eric6/Documentation/Help/source.qhp file | annotate | diff | comparison | revisions
eric6/Documentation/Source/eric6.PluginManager.PluginRepositoryDialog.html file | annotate | diff | comparison | revisions
eric6/Documentation/Source/eric6.eric6_post_install.html file | annotate | diff | comparison | revisions
eric6/Documentation/Source/index-eric6.html file | annotate | diff | comparison | revisions
eric6/Documentation/Source/index.html file | annotate | diff | comparison | revisions
eric6/Documentation/Source/setup.html file | annotate | diff | comparison | revisions
--- a/eric6/APIs/Python3/eric6.api	Sun Apr 21 15:09:31 2019 +0200
+++ b/eric6/APIs/Python3/eric6.api	Sun Apr 21 15:10:54 2019 +0200
@@ -4149,6 +4149,7 @@
 eric6.PluginManager.PluginRepositoryDialog.PluginRepositoryWidget.AuthorRole?7
 eric6.PluginManager.PluginRepositoryDialog.PluginRepositoryWidget.DescrRole?7
 eric6.PluginManager.PluginRepositoryDialog.PluginRepositoryWidget.FilenameRole?7
+eric6.PluginManager.PluginRepositoryDialog.PluginRepositoryWidget.PluginStatusError?7
 eric6.PluginManager.PluginRepositoryDialog.PluginRepositoryWidget.PluginStatusLocalUpdate?7
 eric6.PluginManager.PluginRepositoryDialog.PluginRepositoryWidget.PluginStatusNew?7
 eric6.PluginManager.PluginRepositoryDialog.PluginRepositoryWidget.PluginStatusRemoteUpdate?7
@@ -12931,6 +12932,15 @@
 eric6.eric6_pluginrepository.main?4()
 eric6.eric6_pluginuninstall.createMainWidget?4(argv)
 eric6.eric6_pluginuninstall.main?4()
+eric6.eric6_post_install.copyDesktopFile?4(src, dst, scriptsdir)
+eric6.eric6_post_install.copyLinuxMetaData?4()
+eric6.eric6_post_install.copyMetaFilesTree?4(src, dst)
+eric6.eric6_post_install.createWindowsLinks?4()
+eric6.eric6_post_install.createWindowsShortcut?4(linkPath, targetPath, iconPath)
+eric6.eric6_post_install.getWinregEntry?4(name, path)
+eric6.eric6_post_install.main?4()
+eric6.eric6_post_install.windowsDesktopEntries?4()
+eric6.eric6_post_install.windowsProgramsEntry?4()
 eric6.eric6_qregexp.createMainWidget?4(argv)
 eric6.eric6_qregexp.main?4()
 eric6.eric6_qregularexpression.createMainWidget?4(argv)
@@ -13056,6 +13066,18 @@
 patch_modpython.modDir?7
 patch_modpython.progName?7
 patch_modpython.usage?4(rcode=2)
+setup.Version?7
+setup.appdataFileName?7
+setup.cleanupSource?4(dirName)
+setup.compileUiFiles?4(dirName)
+setup.getDataFiles?4()
+setup.getLongDescription?4()
+setup.getPackageData?4(package, extensions)
+setup.getVersion?4()
+setup.infoFileName?7
+setup.prepareAppdataFile?4(fileName, version)
+setup.prepareInfoFile?4(fileName, version)
+setup.sourceDir?7
 uninstall-debugclients.currDir?7
 uninstall-debugclients.exit?4(rcode=0)
 uninstall-debugclients.initGlobals?4()
Binary file eric6/Documentation/Help/source.qch has changed
--- a/eric6/Documentation/Help/source.qhp	Sun Apr 21 15:09:31 2019 +0200
+++ b/eric6/Documentation/Help/source.qhp	Sun Apr 21 15:10:54 2019 +0200
@@ -1511,6 +1511,7 @@
           <section title="eric6.eric6_plugininstall" ref="eric6.eric6_plugininstall.html" />
           <section title="eric6.eric6_pluginrepository" ref="eric6.eric6_pluginrepository.html" />
           <section title="eric6.eric6_pluginuninstall" ref="eric6.eric6_pluginuninstall.html" />
+          <section title="eric6.eric6_post_install" ref="eric6.eric6_post_install.html" />
           <section title="eric6.eric6_qregexp" ref="eric6.eric6_qregexp.html" />
           <section title="eric6.eric6_qregularexpression" ref="eric6.eric6_qregularexpression.html" />
           <section title="eric6.eric6_re" ref="eric6.eric6_re.html" />
@@ -1531,6 +1532,7 @@
         <section title="install-debugclients" ref="install-debugclients.html" />
         <section title="install-i18n" ref="install-i18n.html" />
         <section title="patch_modpython" ref="patch_modpython.html" />
+        <section title="setup" ref="setup.html" />
         <section title="uninstall" ref="uninstall.html" />
         <section title="uninstall-debugclients" ref="uninstall-debugclients.html" />
       </section>
@@ -18997,6 +18999,7 @@
       <keyword name="__pyName" id="__pyName" ref="compileUiFiles.html#__pyName" />
       <keyword name="__pyName" id="__pyName" ref="eric6.Utilities.uic.html#__pyName" />
       <keyword name="__pyName" id="__pyName" ref="install.html#__pyName" />
+      <keyword name="__pyName" id="__pyName" ref="setup.html#__pyName" />
       <keyword name="__readShortcut" id="__readShortcut" ref="eric6.Preferences.Shortcuts.html#__readShortcut" />
       <keyword name="__render" id="__render" ref="eric6.Helpviewer.HelpSnap.html#__render" />
       <keyword name="__render" id="__render" ref="eric6.WebBrowser.WebBrowserSnap.html#__render" />
@@ -19045,6 +19048,7 @@
       <keyword name="cleanupSource" id="cleanupSource" ref="cleanupSource.html#cleanupSource" />
       <keyword name="cleanupSource" id="cleanupSource" ref="install-debugclients.html#cleanupSource" />
       <keyword name="cleanupSource" id="cleanupSource" ref="install.html#cleanupSource" />
+      <keyword name="cleanupSource" id="cleanupSource" ref="setup.html#cleanupSource" />
       <keyword name="cleanupSource (Module)" id="cleanupSource (Module)" ref="cleanupSource.html" />
       <keyword name="clearPrivateData" id="clearPrivateData" ref="eric6.Plugins.PluginVcsGit.html#clearPrivateData" />
       <keyword name="clearPrivateData" id="clearPrivateData" ref="eric6.Plugins.PluginVcsMercurial.html#clearPrivateData" />
@@ -19058,6 +19062,7 @@
       <keyword name="compileUiFiles" id="compileUiFiles" ref="compileUiFiles.html#compileUiFiles" />
       <keyword name="compileUiFiles" id="compileUiFiles" ref="eric6.Utilities.uic.html#compileUiFiles" />
       <keyword name="compileUiFiles" id="compileUiFiles" ref="install.html#compileUiFiles" />
+      <keyword name="compileUiFiles" id="compileUiFiles" ref="setup.html#compileUiFiles" />
       <keyword name="compileUiFiles (Module)" id="compileUiFiles (Module)" ref="compileUiFiles.html" />
       <keyword name="completeFormData" id="completeFormData" ref="eric6.WebBrowser.Tools.Scripts.html#completeFormData" />
       <keyword name="composeCallPath" id="composeCallPath" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#composeCallPath" />
@@ -19071,7 +19076,10 @@
       <keyword name="convertLineEnds" id="convertLineEnds" ref="eric6.Utilities.__init__.html#convertLineEnds" />
       <keyword name="convertPasswords" id="convertPasswords" ref="eric6.Preferences.__init__.html#convertPasswords" />
       <keyword name="copyAppStreamFile" id="copyAppStreamFile" ref="install.html#copyAppStreamFile" />
+      <keyword name="copyDesktopFile" id="copyDesktopFile" ref="eric6.eric6_post_install.html#copyDesktopFile" />
       <keyword name="copyDesktopFile" id="copyDesktopFile" ref="install.html#copyDesktopFile" />
+      <keyword name="copyLinuxMetaData" id="copyLinuxMetaData" ref="eric6.eric6_post_install.html#copyLinuxMetaData" />
+      <keyword name="copyMetaFilesTree" id="copyMetaFilesTree" ref="eric6.eric6_post_install.html#copyMetaFilesTree" />
       <keyword name="copyToFile" id="copyToFile" ref="install.html#copyToFile" />
       <keyword name="copyTree" id="copyTree" ref="install-debugclients.html#copyTree" />
       <keyword name="copyTree" id="copyTree" ref="install.html#copyTree" />
@@ -19178,8 +19186,10 @@
       <keyword name="createMainWidget" id="createMainWidget" ref="eric6.eric6_webbrowser.html#createMainWidget" />
       <keyword name="createPyWrapper" id="createPyWrapper" ref="install.html#createPyWrapper" />
       <keyword name="createTranslatorPage" id="createTranslatorPage" ref="eric6.Plugins.PluginTranslator.html#createTranslatorPage" />
+      <keyword name="createWindowsLinks" id="createWindowsLinks" ref="eric6.eric6_post_install.html#createWindowsLinks" />
       <keyword name="createWindowsLinks" id="createWindowsLinks" ref="install.html#createWindowsLinks" />
       <keyword name="createWindowsShortcut" id="createWindowsShortcut" ref="create_windows_links.html#createWindowsShortcut" />
+      <keyword name="createWindowsShortcut" id="createWindowsShortcut" ref="eric6.eric6_post_install.html#createWindowsShortcut" />
       <keyword name="createWindowsShortcut" id="createWindowsShortcut" ref="install.html#createWindowsShortcut" />
       <keyword name="create_windows_links (Module)" id="create_windows_links (Module)" ref="create_windows_links.html" />
       <keyword name="critical" id="critical" ref="eric6.E5Gui.E5MessageBox.html#critical" />
@@ -19230,6 +19240,7 @@
       <keyword name="eric6_plugininstall (Module)" id="eric6_plugininstall (Module)" ref="eric6.eric6_plugininstall.html" />
       <keyword name="eric6_pluginrepository (Module)" id="eric6_pluginrepository (Module)" ref="eric6.eric6_pluginrepository.html" />
       <keyword name="eric6_pluginuninstall (Module)" id="eric6_pluginuninstall (Module)" ref="eric6.eric6_pluginuninstall.html" />
+      <keyword name="eric6_post_install (Module)" id="eric6_post_install (Module)" ref="eric6.eric6_post_install.html" />
       <keyword name="eric6_qregexp (Module)" id="eric6_qregexp (Module)" ref="eric6.eric6_qregexp.html" />
       <keyword name="eric6_qregularexpression (Module)" id="eric6_qregularexpression (Module)" ref="eric6.eric6_qregularexpression.html" />
       <keyword name="eric6_re (Module)" id="eric6_re (Module)" ref="eric6.eric6_re.html" />
@@ -19311,6 +19322,7 @@
       <keyword name="getConfigPath" id="getConfigPath" ref="eric6.Plugins.VcsPlugins.vcsSubversion.SvnUtilities.html#getConfigPath" />
       <keyword name="getCooperation" id="getCooperation" ref="eric6.Preferences.__init__.html#getCooperation" />
       <keyword name="getCorba" id="getCorba" ref="eric6.Preferences.__init__.html#getCorba" />
+      <keyword name="getDataFiles" id="getDataFiles" ref="setup.html#getDataFiles" />
       <keyword name="getDebugger" id="getDebugger" ref="eric6.Preferences.__init__.html#getDebugger" />
       <keyword name="getDefaultLexerAssociations" id="getDefaultLexerAssociations" ref="eric6.QScintilla.Lexers.__init__.html#getDefaultLexerAssociations" />
       <keyword name="getDefaults" id="getDefaults" ref="eric6.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.__init__.html#getDefaults" />
@@ -19370,6 +19382,7 @@
       <keyword name="getKeyUrl" id="getKeyUrl" ref="eric6.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.__init__.html#getKeyUrl" />
       <keyword name="getLanguageIcon" id="getLanguageIcon" ref="eric6.QScintilla.Lexers.__init__.html#getLanguageIcon" />
       <keyword name="getLexer" id="getLexer" ref="eric6.QScintilla.Lexers.__init__.html#getLexer" />
+      <keyword name="getLongDescription" id="getLongDescription" ref="setup.html#getLongDescription" />
       <keyword name="getMarkupProvider" id="getMarkupProvider" ref="eric6.QScintilla.MarkupProviders.__init__.html#getMarkupProvider" />
       <keyword name="getMultiProject" id="getMultiProject" ref="eric6.Preferences.__init__.html#getMultiProject" />
       <keyword name="getOpenFileFiltersList" id="getOpenFileFiltersList" ref="eric6.QScintilla.Lexers.__init__.html#getOpenFileFiltersList" />
@@ -19378,6 +19391,7 @@
       <keyword name="getOpenFileNames" id="getOpenFileNames" ref="eric6.E5Gui.E5FileDialog.html#getOpenFileNames" />
       <keyword name="getOpenFileNamesAndFilter" id="getOpenFileNamesAndFilter" ref="eric6.E5Gui.E5FileDialog.html#getOpenFileNamesAndFilter" />
       <keyword name="getOpenSearchLinks" id="getOpenSearchLinks" ref="eric6.WebBrowser.Tools.Scripts.html#getOpenSearchLinks" />
+      <keyword name="getPackageData" id="getPackageData" ref="setup.html#getPackageData" />
       <keyword name="getPath" id="getPath" ref="eric6.E5Gui.E5PathPickerDialog.html#getPath" />
       <keyword name="getPercentReplacement" id="getPercentReplacement" ref="eric6.Utilities.__init__.html#getPercentReplacement" />
       <keyword name="getPercentReplacementHelp" id="getPercentReplacementHelp" ref="eric6.Utilities.__init__.html#getPercentReplacementHelp" />
@@ -19435,12 +19449,14 @@
       <keyword name="getVcsSystemIndicator" id="getVcsSystemIndicator" ref="eric6.Plugins.PluginVcsMercurial.html#getVcsSystemIndicator" />
       <keyword name="getVcsSystemIndicator" id="getVcsSystemIndicator" ref="eric6.Plugins.PluginVcsPySvn.html#getVcsSystemIndicator" />
       <keyword name="getVcsSystemIndicator" id="getVcsSystemIndicator" ref="eric6.Plugins.PluginVcsSubversion.html#getVcsSystemIndicator" />
+      <keyword name="getVersion" id="getVersion" ref="setup.html#getVersion" />
       <keyword name="getViewManager" id="getViewManager" ref="eric6.Preferences.__init__.html#getViewManager" />
       <keyword name="getWebBrowser" id="getWebBrowser" ref="eric6.Preferences.__init__.html#getWebBrowser" />
       <keyword name="getWebBrowserSupport" id="getWebBrowserSupport" ref="eric6.Globals.__init__.html#getWebBrowserSupport" />
       <keyword name="getWebEngineVersions" id="getWebEngineVersions" ref="eric6.WebBrowser.Tools.WebBrowserTools.html#getWebEngineVersions" />
       <keyword name="getWindowsExecutablePath" id="getWindowsExecutablePath" ref="eric6.Utilities.__init__.html#getWindowsExecutablePath" />
       <keyword name="getWinregEntry" id="getWinregEntry" ref="create_windows_links.html#getWinregEntry" />
+      <keyword name="getWinregEntry" id="getWinregEntry" ref="eric6.eric6_post_install.html#getWinregEntry" />
       <keyword name="getWinregEntry" id="getWinregEntry" ref="install.html#getWinregEntry" />
       <keyword name="getWinregEntry" id="getWinregEntry" ref="uninstall.html#getWinregEntry" />
       <keyword name="get_class_members" id="get_class_members" ref="eric6.DebugClients.Python.FlexCompleter.html#get_class_members" />
@@ -19549,6 +19565,7 @@
       <keyword name="main" id="main" ref="eric6.eric6_plugininstall.html#main" />
       <keyword name="main" id="main" ref="eric6.eric6_pluginrepository.html#main" />
       <keyword name="main" id="main" ref="eric6.eric6_pluginuninstall.html#main" />
+      <keyword name="main" id="main" ref="eric6.eric6_post_install.html#main" />
       <keyword name="main" id="main" ref="eric6.eric6_qregexp.html#main" />
       <keyword name="main" id="main" ref="eric6.eric6_qregularexpression.html#main" />
       <keyword name="main" id="main" ref="eric6.eric6_re.html#main" />
@@ -19604,10 +19621,12 @@
       <keyword name="pixmapFromByteArray" id="pixmapFromByteArray" ref="eric6.WebBrowser.Tools.WebBrowserTools.html#pixmapFromByteArray" />
       <keyword name="pixmapToByteArray" id="pixmapToByteArray" ref="eric6.WebBrowser.Tools.WebBrowserTools.html#pixmapToByteArray" />
       <keyword name="pixmapToDataUrl" id="pixmapToDataUrl" ref="eric6.WebBrowser.Tools.WebBrowserTools.html#pixmapToDataUrl" />
+      <keyword name="prepareAppdataFile" id="prepareAppdataFile" ref="setup.html#prepareAppdataFile" />
       <keyword name="prepareDocumentationViewerHtmlDocWarningDocument" id="prepareDocumentationViewerHtmlDocWarningDocument" ref="eric6.UI.CodeDocumentationViewerTemplate.html#prepareDocumentationViewerHtmlDocWarningDocument" />
       <keyword name="prepareDocumentationViewerHtmlDocument" id="prepareDocumentationViewerHtmlDocument" ref="eric6.UI.CodeDocumentationViewerTemplate.html#prepareDocumentationViewerHtmlDocument" />
       <keyword name="prepareDocumentationViewerHtmlWarningDocument" id="prepareDocumentationViewerHtmlWarningDocument" ref="eric6.UI.CodeDocumentationViewerTemplate.html#prepareDocumentationViewerHtmlWarningDocument" />
       <keyword name="prepareInfoFile" id="prepareInfoFile" ref="install.html#prepareInfoFile" />
+      <keyword name="prepareInfoFile" id="prepareInfoFile" ref="setup.html#prepareInfoFile" />
       <keyword name="prepareJsonCommand" id="prepareJsonCommand" ref="eric6.DebugClients.Python.DebugUtilities.html#prepareJsonCommand" />
       <keyword name="prepareProcess" id="prepareProcess" ref="eric6.Plugins.VcsPlugins.vcsGit.GitUtilities.html#prepareProcess" />
       <keyword name="prepareProcess" id="prepareProcess" ref="eric6.Plugins.VcsPlugins.vcsMercurial.HgUtilities.html#prepareProcess" />
@@ -19758,6 +19777,7 @@
       <keyword name="setVarFilters" id="setVarFilters" ref="eric6.Preferences.__init__.html#setVarFilters" />
       <keyword name="setViewManager" id="setViewManager" ref="eric6.Preferences.__init__.html#setViewManager" />
       <keyword name="setWebBrowser" id="setWebBrowser" ref="eric6.Preferences.__init__.html#setWebBrowser" />
+      <keyword name="setup (Module)" id="setup (Module)" ref="setup.html" />
       <keyword name="setupFormObserver" id="setupFormObserver" ref="eric6.WebBrowser.Tools.Scripts.html#setupFormObserver" />
       <keyword name="setupWebChannel" id="setupWebChannel" ref="eric6.WebBrowser.Tools.Scripts.html#setupWebChannel" />
       <keyword name="setupWindowObject" id="setupWindowObject" ref="eric6.WebBrowser.Tools.Scripts.html#setupWindowObject" />
@@ -19853,11 +19873,13 @@
       <keyword name="win32_Kill" id="win32_Kill" ref="eric6.Utilities.__init__.html#win32_Kill" />
       <keyword name="win32_getRealName" id="win32_getRealName" ref="eric6.Utilities.__init__.html#win32_getRealName" />
       <keyword name="windowsDesktopEntries" id="windowsDesktopEntries" ref="create_windows_links.html#windowsDesktopEntries" />
+      <keyword name="windowsDesktopEntries" id="windowsDesktopEntries" ref="eric6.eric6_post_install.html#windowsDesktopEntries" />
       <keyword name="windowsDesktopEntries" id="windowsDesktopEntries" ref="install.html#windowsDesktopEntries" />
       <keyword name="windowsDesktopNames" id="windowsDesktopNames" ref="create_windows_links.html#windowsDesktopNames" />
       <keyword name="windowsDesktopNames" id="windowsDesktopNames" ref="install.html#windowsDesktopNames" />
       <keyword name="windowsDesktopNames" id="windowsDesktopNames" ref="uninstall.html#windowsDesktopNames" />
       <keyword name="windowsProgramsEntry" id="windowsProgramsEntry" ref="create_windows_links.html#windowsProgramsEntry" />
+      <keyword name="windowsProgramsEntry" id="windowsProgramsEntry" ref="eric6.eric6_post_install.html#windowsProgramsEntry" />
       <keyword name="windowsProgramsEntry" id="windowsProgramsEntry" ref="install.html#windowsProgramsEntry" />
       <keyword name="windowsProgramsEntry" id="windowsProgramsEntry" ref="uninstall.html#windowsProgramsEntry" />
       <keyword name="worker" id="worker" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.html#worker" />
@@ -21063,6 +21085,7 @@
       <file>eric6.eric6_plugininstall.html</file>
       <file>eric6.eric6_pluginrepository.html</file>
       <file>eric6.eric6_pluginuninstall.html</file>
+      <file>eric6.eric6_post_install.html</file>
       <file>eric6.eric6_qregexp.html</file>
       <file>eric6.eric6_qregularexpression.html</file>
       <file>eric6.eric6_re.html</file>
@@ -21245,6 +21268,7 @@
       <file>install-i18n.html</file>
       <file>install.html</file>
       <file>patch_modpython.html</file>
+      <file>setup.html</file>
       <file>uninstall-debugclients.html</file>
       <file>uninstall.html</file>
     </files>
--- a/eric6/Documentation/Source/eric6.PluginManager.PluginRepositoryDialog.html	Sun Apr 21 15:09:31 2019 +0200
+++ b/eric6/Documentation/Source/eric6.PluginManager.PluginRepositoryDialog.html	Sun Apr 21 15:10:54 2019 +0200
@@ -130,7 +130,7 @@
 QWidget, Ui_PluginRepositoryDialog
 <h3>Class Attributes</h3>
 <table>
-<tr><td>AuthorRole</td></tr><tr><td>DescrRole</td></tr><tr><td>FilenameRole</td></tr><tr><td>PluginStatusLocalUpdate</td></tr><tr><td>PluginStatusNew</td></tr><tr><td>PluginStatusRemoteUpdate</td></tr><tr><td>PluginStatusUpToDate</td></tr><tr><td>UrlRole</td></tr>
+<tr><td>AuthorRole</td></tr><tr><td>DescrRole</td></tr><tr><td>FilenameRole</td></tr><tr><td>PluginStatusError</td></tr><tr><td>PluginStatusLocalUpdate</td></tr><tr><td>PluginStatusNew</td></tr><tr><td>PluginStatusRemoteUpdate</td></tr><tr><td>PluginStatusUpToDate</td></tr><tr><td>UrlRole</td></tr>
 </table>
 <h3>Class Methods</h3>
 <table>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/eric6/Documentation/Source/eric6.eric6_post_install.html	Sun Apr 21 15:10:54 2019 +0200
@@ -0,0 +1,207 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric6.eric6_post_install</title>
+<meta charset="UTF-8">
+<style>
+body {
+    background: #EDECE6;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+    
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>eric6.eric6_post_install</h1>
+<p>
+Module implemenzing the post install logic for 'pip install'.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr>
+<td><a href="#copyDesktopFile">copyDesktopFile</a></td>
+<td>Modify a desktop file and write it to its destination.</td>
+</tr><tr>
+<td><a href="#copyLinuxMetaData">copyLinuxMetaData</a></td>
+<td>Function to copy the meta data files.</td>
+</tr><tr>
+<td><a href="#copyMetaFilesTree">copyMetaFilesTree</a></td>
+<td>Function to copy the files of a directory tree.</td>
+</tr><tr>
+<td><a href="#createWindowsLinks">createWindowsLinks</a></td>
+<td>Create Desktop and Start Menu links.</td>
+</tr><tr>
+<td><a href="#createWindowsShortcut">createWindowsShortcut</a></td>
+<td>Create Windows shortcut.</td>
+</tr><tr>
+<td><a href="#getWinregEntry">getWinregEntry</a></td>
+<td>Function to get an entry from the Windows Registry.</td>
+</tr><tr>
+<td><a href="#main">main</a></td>
+<td>Main script orchestrating the platform dependent post installation tasks.</td>
+</tr><tr>
+<td><a href="#windowsDesktopEntries">windowsDesktopEntries</a></td>
+<td>Function to generate data for the Windows Desktop links.</td>
+</tr><tr>
+<td><a href="#windowsProgramsEntry">windowsProgramsEntry</a></td>
+<td>Function to generate the name of the Start Menu top entry.</td>
+</tr>
+</table>
+<hr /><hr />
+<a NAME="copyDesktopFile" ID="copyDesktopFile"></a>
+<h2>copyDesktopFile</h2>
+<b>copyDesktopFile</b>(<i>src, dst, scriptsdir</i>)
+<p>
+    Modify a desktop file and write it to its destination.
+</p><dl>
+<dt><i>src</i></dt>
+<dd>
+source file name (string)
+</dd><dt><i>dst</i></dt>
+<dd>
+destination file name (string)
+</dd><dt><i>scriptsdir</i></dt>
+<dd>
+directory containing the scripts (string)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="copyLinuxMetaData" ID="copyLinuxMetaData"></a>
+<h2>copyLinuxMetaData</h2>
+<b>copyLinuxMetaData</b>(<i></i>)
+<p>
+    Function to copy the meta data files.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="copyMetaFilesTree" ID="copyMetaFilesTree"></a>
+<h2>copyMetaFilesTree</h2>
+<b>copyMetaFilesTree</b>(<i>src, dst</i>)
+<p>
+    Function to copy the files of a directory tree.
+</p><dl>
+<dt><i>src</i></dt>
+<dd>
+name of the source directory
+</dd><dt><i>dst</i></dt>
+<dd>
+name of the destination directory
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="createWindowsLinks" ID="createWindowsLinks"></a>
+<h2>createWindowsLinks</h2>
+<b>createWindowsLinks</b>(<i></i>)
+<p>
+    Create Desktop and Start Menu links.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="createWindowsShortcut" ID="createWindowsShortcut"></a>
+<h2>createWindowsShortcut</h2>
+<b>createWindowsShortcut</b>(<i>linkPath, targetPath, iconPath</i>)
+<p>
+    Create Windows shortcut.
+</p><dl>
+<dt><i>linkPath</i> (str)</dt>
+<dd>
+path of the shortcut file
+</dd><dt><i>targetPath</i> (str)</dt>
+<dd>
+path the shortcut shall point to
+</dd><dt><i>iconPath</i> (str)</dt>
+<dd>
+path of the icon file
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="getWinregEntry" ID="getWinregEntry"></a>
+<h2>getWinregEntry</h2>
+<b>getWinregEntry</b>(<i>name, path</i>)
+<p>
+    Function to get an entry from the Windows Registry.
+</p><dl>
+<dt><i>name</i> (str)</dt>
+<dd>
+variable name
+</dd><dt><i>path</i> (str)</dt>
+<dd>
+registry path of the variable
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+value of requested registry variable
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+any
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="main" ID="main"></a>
+<h2>main</h2>
+<b>main</b>(<i></i>)
+<p>
+    Main script orchestrating the platform dependent post installation tasks.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="windowsDesktopEntries" ID="windowsDesktopEntries"></a>
+<h2>windowsDesktopEntries</h2>
+<b>windowsDesktopEntries</b>(<i></i>)
+<p>
+    Function to generate data for the Windows Desktop links.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+list of tuples containing the desktop link name,
+        the link target and the icon target
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+list of tuples of (str, str, str)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="windowsProgramsEntry" ID="windowsProgramsEntry"></a>
+<h2>windowsProgramsEntry</h2>
+<b>windowsProgramsEntry</b>(<i></i>)
+<p>
+    Function to generate the name of the Start Menu top entry.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+name of the Start Menu top entry
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
--- a/eric6/Documentation/Source/index-eric6.html	Sun Apr 21 15:09:31 2019 +0200
+++ b/eric6/Documentation/Source/index-eric6.html	Sun Apr 21 15:10:54 2019 +0200
@@ -185,6 +185,9 @@
 <td><a href="eric6.eric6_pluginuninstall.html">eric6_pluginuninstall</a></td>
 <td>Eric6 Plugin Uninstaller.</td>
 </tr><tr>
+<td><a href="eric6.eric6_post_install.html">eric6_post_install</a></td>
+<td>Module implemenzing the post install logic for 'pip install'.</td>
+</tr><tr>
 <td><a href="eric6.eric6_qregexp.html">eric6_qregexp</a></td>
 <td>Eric6 QRegExp.</td>
 </tr><tr>
--- a/eric6/Documentation/Source/index.html	Sun Apr 21 15:09:31 2019 +0200
+++ b/eric6/Documentation/Source/index.html	Sun Apr 21 15:10:54 2019 +0200
@@ -54,6 +54,9 @@
 <td><a href="patch_modpython.html">patch_modpython</a></td>
 <td>Script to patch mod_python for usage with the eric6 IDE.</td>
 </tr><tr>
+<td><a href="setup.html">setup</a></td>
+<td>Module to prepare a distribution package for uploading to PyPI.</td>
+</tr><tr>
 <td><a href="uninstall.html">uninstall</a></td>
 <td>Uninstallation script for the eric6 IDE and all eric6 related tools.</td>
 </tr><tr>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/eric6/Documentation/Source/setup.html	Sun Apr 21 15:10:54 2019 +0200
@@ -0,0 +1,227 @@
+<!DOCTYPE html>
+<html><head>
+<title>setup</title>
+<meta charset="UTF-8">
+<style>
+body {
+    background: #EDECE6;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+    
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>setup</h1>
+<p>
+Module to prepare a distribution package for uploading to PyPI.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>Version</td></tr><tr><td>appdataFileName</td></tr><tr><td>infoFileName</td></tr><tr><td>sourceDir</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr>
+<td><a href="#__pyName">__pyName</a></td>
+<td>Local function to create the Python source file name for the compiled .ui file.</td>
+</tr><tr>
+<td><a href="#cleanupSource">cleanupSource</a></td>
+<td>Cleanup the sources directory to get rid of leftover files and directories.</td>
+</tr><tr>
+<td><a href="#compileUiFiles">compileUiFiles</a></td>
+<td>Compile the .ui files to Python sources.</td>
+</tr><tr>
+<td><a href="#getDataFiles">getDataFiles</a></td>
+<td>Function to return data_files in a platform dependent manner.</td>
+</tr><tr>
+<td><a href="#getLongDescription">getLongDescription</a></td>
+<td>Function to get the long description via the README file.</td>
+</tr><tr>
+<td><a href="#getPackageData">getPackageData</a></td>
+<td>Function to return data files of a package with givene extensions.</td>
+</tr><tr>
+<td><a href="#getVersion">getVersion</a></td>
+<td>Function to get the version from file.</td>
+</tr><tr>
+<td><a href="#prepareAppdataFile">prepareAppdataFile</a></td>
+<td>Function to prepare a .appdata.xml file.</td>
+</tr><tr>
+<td><a href="#prepareInfoFile">prepareInfoFile</a></td>
+<td>Function to prepare an Info.py file.</td>
+</tr>
+</table>
+<hr /><hr />
+<a NAME="__pyName" ID="__pyName"></a>
+<h2>__pyName</h2>
+<b>__pyName</b>(<i>py_dir, py_file</i>)
+<p>
+    Local function to create the Python source file name for the compiled
+    .ui file.
+</p><dl>
+<dt><i>py_dir</i></dt>
+<dd>
+suggested name of the directory (string)
+</dd><dt><i>py_file</i></dt>
+<dd>
+suggested name for the compile source file (string)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+tuple of directory name (string) and source file name (string)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="cleanupSource" ID="cleanupSource"></a>
+<h2>cleanupSource</h2>
+<b>cleanupSource</b>(<i>dirName</i>)
+<p>
+    Cleanup the sources directory to get rid of leftover files
+    and directories.
+</p><dl>
+<dt><i>dirName</i></dt>
+<dd>
+name of the directory to prune (string)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="compileUiFiles" ID="compileUiFiles"></a>
+<h2>compileUiFiles</h2>
+<b>compileUiFiles</b>(<i>dirName</i>)
+<p>
+    Compile the .ui files to Python sources.
+</p><dl>
+<dt><i>dirName</i></dt>
+<dd>
+name of the directory to compile UI files for (string)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="getDataFiles" ID="getDataFiles"></a>
+<h2>getDataFiles</h2>
+<b>getDataFiles</b>(<i></i>)
+<p>
+    Function to return data_files in a platform dependent manner.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+list containing the platform specific data files
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+list of tuples of (str, list of str)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="getLongDescription" ID="getLongDescription"></a>
+<h2>getLongDescription</h2>
+<b>getLongDescription</b>(<i></i>)
+<p>
+    Function to get the long description via the README file.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+long description
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="getPackageData" ID="getPackageData"></a>
+<h2>getPackageData</h2>
+<b>getPackageData</b>(<i>package, extensions</i>)
+<p>
+    Function to return data files of a package with givene extensions.
+</p><dl>
+<dt><i>package</i> (str)</dt>
+<dd>
+name of the package directory
+</dd><dt><i>extensions</i> (list of str)</dt>
+<dd>
+list of extensions to test for
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+list of package data files
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="getVersion" ID="getVersion"></a>
+<h2>getVersion</h2>
+<b>getVersion</b>(<i></i>)
+<p>
+    Function to get the version from file.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+string containing the version
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="prepareAppdataFile" ID="prepareAppdataFile"></a>
+<h2>prepareAppdataFile</h2>
+<b>prepareAppdataFile</b>(<i>fileName, version</i>)
+<p>
+    Function to prepare a .appdata.xml file.
+</p><dl>
+<dt><i>fileName</i></dt>
+<dd>
+name of the .appdata.xml file (string)
+</dd><dt><i>version</i></dt>
+<dd>
+version string for the package (string)
+</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, version</i>)
+<p>
+    Function to prepare an Info.py file.
+</p><dl>
+<dt><i>fileName</i></dt>
+<dd>
+name of the Python file containing the info (string)
+</dd><dt><i>version</i></dt>
+<dd>
+version string for the package (string)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial