install

Installation script for the eric6 IDE and all eric6 related tools.

Global Attributes

Classes

Functions

__pyName

Local function to create the Python source file name for the compiled .ui file.

py_dir

suggested name of the directory (string)

py_file

suggested name for the compile source file (string)

Returns:

tuple of directory name (string) and source file name (string)

cleanUp

Uninstall the old eric files.

cleanUpLinuxSpecifics

Clean up Linux specific files.

cleanUpMacAppBundle

Uninstall the macOS application bundle.

cleanUpWindowsLinks

Clean up the Desktop and Start Menu entries for Windows.

cleanupSource

Cleanup the sources directory to get rid of leftover files and directories.

dirName

name of the directory to prune (string)

compileUiFiles

Compile the .ui files to Python sources.

copyAppStreamFile

Modify an appstream file and write it to its destination.

src

source file name (string)

dst

destination file name (string)

copyDesktopFile

Modify a desktop file and write it to its destination.

src

source file name (string)

dst

destination file name (string)

copyToFile

Copy a string to a file.

name

the name of the file.

text

the contents to copy to the file.

copyTree

Copy Python, translation, documentation, wizards configuration, designer template files and DTDs of a directory tree.

src

name of the source directory

dst

name of the destination directory

filters

list of filter pattern determining the files to be copied

excludeDirs

list of (sub)directories to exclude from copying

excludePatterns=

list of filter pattern determining the files to be skipped

createConfig

Create a config file with the respective config entries.

createGlobalPluginsDir

Create the global plugins directory, if it doesn't exist.

createInstallConfig

Create the installation config dictionary.

createLinuxSpecifics

Install Linux specific files.

createMacAppBundle

Create a Mac application bundle.

pydir (str)

the name of the directory where the Python script will eventually be installed

createPyWrapper

Create an executable wrapper for a Python script.

pydir

the name of the directory where the Python script will eventually be installed (string)

wfile

the basename of the wrapper (string)

saveDir

directory to save the file into (string)

isGuiScript

flag indicating a wrapper script for a GUI application (boolean)

Returns:

the platform specific name of the wrapper (string)

createWindowsLinks

Create Desktop and Start Menu links.

createWindowsShortcut

Create Windows shortcut.

linkPath (str)

path of the shortcut file

targetPath (str)

path the shortcut shall point to

iconPath (str)

path of the icon file

doDependancyChecks

Perform some dependency checks.

exit

Exit the install script.

rcode

result code to report back (integer)

getWinregEntry

Function to get an entry from the Windows Registry.

name (str)

variable name

path (str)

registry path of the variable

Returns:

value of requested registry variable

Return Type:

any

initGlobals

Module function to set the values of globals that need more than a simple assignment.

installEric

Actually perform the installation steps.

Returns:

result code (integer)

isPipOutdated

Check, if pip is outdated.

Returns:

flag indicating an outdated pip

Return Type:

bool

main

The main function of the script.

argv (list of str)

list of command line arguments

pipInstall

Install the given package via pip.

packageName (str)

name of the package to be installed

message (str)

message to be shown to the user

Returns:

flag indicating a successful installation

Return Type:

bool

prepareInfoFile

Function to prepare an Info.py file when installing from source.

fileName

name of the Python file containing the info (string)

shutilCopy

Wrapper function around shutil.copy() to ensure the permissions.

src

source file name (string)

dst

destination file name or directory name (string)

perm=

permissions to be set (integer)

updatePip

Update the installed pip package.

usage

Display a usage message and exit.

rcode

the return code passed back to the calling process.

windowsDesktopEntries

Function to generate data for the Windows Desktop links.

Returns:

list of tuples containing the desktop link name, the link target and the icon target

Return Type:

list of tuples of (str, str, str)

windowsDesktopNames

Function to generate the link names for the Windows Desktop.

Returns:

list of desktop link names

Return Type:

list of str

windowsProgramsEntry

Function to generate the name of the Start Menu top entry.

Returns:

name of the Start Menu top entry

Return Type:

str

wrapperNames

Create the platform specific names for the wrapper script.

dname

name of the directory to place the wrapper into

wfile

basename (without extension) of the wrapper script

Returns:

the names of the wrapper scripts