eric6.install

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

Global Attributes

BlackLists
PlatformsBlackLists
PythonMarkers
PythonTextMarkers
apisDir
cfg
configLength
configName
currDir
defaultMacAppBundleName
defaultMacAppBundlePath
defaultMacPythonExe
distDir
doCleanup
doCompile
includePythonVariant
installApis
macAppBundleName
macAppBundlePath
macPythonExe
modDir
platBinDir
platBinDirOld
progLanguages
progName
pyModDir
pyqtOverride
pyqtVariant
sourceDir

Classes

None

Functions

__pyName Local function to create the Python source file name for the compiled .ui file.
cleanUp Uninstall the old eric files.
cleanupSource Cleanup the sources directory to get rid of leftover files and directories.
compileUiFiles Compile the .ui files to Python sources.
copyAppStreamFile Modify an appstream file and write it to its destination.
copyDesktopFile Modify a desktop file and write it to its destination.
copyToFile Copy a string to a file.
copyTree Copy Python, translation, documentation, wizards configuration, designer template files and DTDs of a directory tree.
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.
createMacAppBundle Create a Mac application bundle.
createPyWrapper Create an executable wrapper for a Python script.
determinePyQtVariant Module function to determine the PyQt variant to be used.
doDependancyChecks Perform some dependency checks.
exit Exit the install script.
initGlobals Module function to set the values of globals that need more than a simple assignment.
installEric Actually perform the installation steps.
main The main function of the script.
pipInstall Install the given package via pip.
prepareInfoFile Function to prepare an Info.py file when installing from source.
shutilCopy Wrapper function around shutil.copy() to ensure the permissions.
usage Display a usage message and exit.
wrapperName Create the platform specific name for the wrapper script.


__pyName

__pyName(py_dir, py_file)

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)
Up


cleanUp

cleanUp()

Uninstall the old eric files.

Up


cleanupSource

cleanupSource(dirName)

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

dirName
name of the directory to prune (string)
Up


compileUiFiles

compileUiFiles()

Compile the .ui files to Python sources.

Up


copyAppStreamFile

copyAppStreamFile(src, dst, marker)

Modify an appstream file and write it to its destination.

src
source file name (string)
dst
destination file name (string)
marker
marker to be used (string)
Up


copyDesktopFile

copyDesktopFile(src, dst, marker)

Modify a desktop file and write it to its destination.

src
source file name (string)
dst
destination file name (string)
marker
marker to be used (string)
Up


copyToFile

copyToFile(name, text)

Copy a string to a file.

name
the name of the file.
text
the contents to copy to the file.
Up


copyTree

copyTree(src, dst, filters, excludeDirs=None, excludePatterns=None)

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
Up


createConfig

createConfig()

Create a config file with the respective config entries.

Up


createGlobalPluginsDir

createGlobalPluginsDir()

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

Up


createInstallConfig

createInstallConfig()

Create the installation config dictionary.

Up


createMacAppBundle

createMacAppBundle(pydir)

Create a Mac application bundle.

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


createPyWrapper

createPyWrapper(pydir, wfile, isGuiScript=True)

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)
isGuiScript
flag indicating a wrapper script for a GUI application (boolean)
Returns:
the platform specific name of the wrapper (string)
Up


determinePyQtVariant

determinePyQtVariant()

Module function to determine the PyQt variant to be used.

Up


doDependancyChecks

doDependancyChecks()

Perform some dependency checks.

Up


exit

exit(rcode=0)

Exit the install script.

rcode
result code to report back (integer)
Up


initGlobals

initGlobals()

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

Up


installEric

installEric()

Actually perform the installation steps.

Returns:
result code (integer)
Up


main

main(argv)

The main function of the script.

argv
the list of command line arguments.
Up


pipInstall

pipInstall(packageName, message)

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
Up


prepareInfoFile

prepareInfoFile(fileName)

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

fileName
name of the Python file containing the info (string)
Up


shutilCopy

shutilCopy(src, dst, perm=0o644)

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)
Up


usage

usage(rcode=2)

Display a usage message and exit.

rcode
the return code passed back to the calling process.
Up


wrapperName

wrapperName(dname, wfile)

Create the platform specific name for the wrapper script.

dname
name of the directory to place the wrapper into
wfile
basename (without extension) of the wrapper script
Returns:
the name of the wrapper script
Up