Installation¶
Modules¶
pymyinstall.installhelper.add_shortcut_to_desktop_for_module
(name)
Adds a shortcut on a module which includes a script.
pymyinstall.installhelper.create_virtual_env
(where, symlinks = False, system_site_packages = False, clear = True, packages = None, fLOG = <built-in function print>, temp_folder = None)
pymyinstall.installhelper.get_module_dependencies
(module, use_cmd = False, deep = False, collapse = True, use_pip = None, refresh_cache = False)
Returns the dependencies for a module.
pymyinstall.installhelper.get_installed_modules
(pypi = False, skip_betas = False, fLOG = None, stop = -1, short_list = None)
Returns all modules recored in this modules. Adds installed modules.
pymyinstall.installhelper.get_module_metadata
(module, use_cmd = False, refresh_cache = False)
Returns a dictionary
{ module: metadata }
.
pymyinstall.get_module_version
(module, use_cmd = False)
Returns a dictionary
{ module: version }
.
pymyinstall.installhelper.get_pip_program
(exe = None)
pymyinstall.get_pypi_version
(module_name, full_list = False, url = ‘https://pypi.python.org/pypi’, skip_betas = True)
Returns the version of a package on pypi, we skip alpha, beta or dev version.
pymyinstall.installhelper.get_wheel_version
(whlname)
extract the version from a wheel file, return
2.6.0
forrpy2-2.6.0-cp34-none-win_amd64.whl
pymyinstall.installhelper.has_pip
()
Tells if pip is installed.
pymyinstall.installhelper.is_installed
(name)
Tells if a module is installed or not.
pymyinstall.installhelper.numeric_version
(vers)
convert a string into a tuple with numbers wherever possible
pymyinstall.run_cmd
(cmd, sin = ‘’, shell = False, wait = False, log_error = True, stop_running_if = None, encerror = ‘ignore’, encoding = ‘utf8’, change_path = None, communicate = True, preprocess = True, timeout = None, catch_exit = False, fLOG = None, tell_if_no_output = None, old_behavior = False)
Runs a command line and waits for the results,
run_cmd_private
.
pymyinstall.installhelper.run_cmd_path
(python_path, script, fLOG = <built-in function print>, file = False, is_cmd = False, kwargs)
run a script knowing python path, it does not raise an exception.
pymyinstall.installhelper.missing_dependencies
(specific = None, ignore_module = [‘argparse’, ‘backports.weakref’, ‘distribute’, ‘enum’, ‘enum34’, ‘enum_compat’, ‘enum-compat’, ‘fasttsne’, ‘futures’, ‘holoviews’, ‘hypertemp’, ‘keyrings.alt’, ‘msgpack_python’, ‘msgpack-python’, ‘onnx’, ‘ordereddict’, ‘path’, ‘path.py’, ‘pathlib’, ‘pip’, ‘pipdeptree’, ‘prettytable’, ‘pycryptodome’, ‘pydocstyle’, ‘pyopengl’, ‘pypiwin32’, ‘pythonnet’, ‘pywin32’, ‘pywin32_ctypes’, ‘rope’, ‘setuptools’])
Returns the list of missing dependencies for the installed modules.
pymyinstall.ModuleInstall
(self, name, kind = ‘pip’, gitrepo = None, mname = None, fLOG = <built-in function print>, version = None, script = None, index_url = None, deps = None, purpose = None, usage = None, web = None, source = None, custom = None, branch = ‘master’, pip_options = None, overwrite = None, post = None, skip_import = False, pipgit = False)
defines the necessary information for a module
pymyinstall.installhelper.run_venv_script
(venv, script, fLOG = <built-in function print>, file = False, is_cmd = False)
run a script on a virtual environment (the script should be simple
pymyinstall.installhelper.update_pip
(python_path = None, fLOG = <built-in function print>)
Updates pip for a specific distribution.
pymyinstall.installhelper.venv_install
(venv, packages, fLOG = <built-in function print>, temp_folder = None)
install a package or a list of packages in a virtual environment
pymyinstall.installhelper.version_consensus
(v1, v2)
v1 and v2 are two versions of the same module, which one to keep?
pymyinstall.installhelper.compare_version
(num, vers)
Compares two versions.
Install¶
pymyinstall.packaged.classifiers2string
(li)
Shortens the list of classifiers into a string.
pymyinstall.download_module
(module_name, temp_folder = ‘.’, force = False, unzipFile = True, file_save = None, deps = False, source = None, fLOG = <built-in function print>)
Downloads the module without installation.
pymyinstall.packaged.find_module_install
(name, must_exist = False)
Checks if there are specific instructions to run before installing module name, on Windows, some modules requires compilation, if not uses default option with pip.
pymyinstall.packaged.get_package_set
(name)
return a list of modules included in one the functions imported in this module
pymyinstall.install_module
(module_name, temp_folder = ‘.’, fLOG = <built-in function print>, verbose = True, reorder = True, skip_module = None, up_pip = True, skip_missing = False, deps = False, schedule_only = False, deep_deps = False, _memory = None, source = None, download_only = False, force = False)
Installs a module.
pymyinstall.packaged.install_module_deps
(name, temp_folder = ‘.’, fLOG = <built-in function print>, verbose = True, deps = True, deep_deps = False, _memory = None, source = None, download_only = False, force = False)
Installs a module with its dependencies, if a module is already installed, it installs the missing dependencies.
pymyinstall.packaged.install_all
(temp_folder = ‘.’, fLOG = <built-in function print>, verbose = True, list_module = None, reorder = True, skip_module = None, up_pip = True, skip_missing = False, deps = False, schedule_only = False, deep_deps = False, _memory = None, source = None, download_only = False, force = False)
Installs modules in list_module if None, this list will be returned by
ensae_fullset()
, the function starts by updating pip.
pymyinstall.packaged.is_64bit
()
tells if the python is 64 bit or not
pymyinstall.packaged.name_sets_dataframe
(module_set = None)
returns a RST tables which described all the available sets
pymyinstall.packaged.update_all
(temp_folder = ‘.’, fLOG = <built-in function print>, verbose = True, list_module = None, reorder = True, skip_module = None, schedule_only = False, source = None, download_only = False)
Updates modules in list_module if None, this list will be returned by
ensae_fullset()
, the function starts by updating pip.
pymyinstall.update_module
(module_name, temp_folder = ‘.’, fLOG = <built-in function print>, verbose = True, reorder = True, skip_module = None, schedule_only = False, source = None)
Updates modules in list_module if None, this list will be returned by
ensae_fullset()
, the function starts by updating pip.
Tools¶
pymyinstall.installcustom.install_7z
(temp_folder = ‘.’, fLOG = <built-in function print>, install = True, force_download = False, version = None)
Install 7z. It does not do it a second time if it is already installed.
pymyinstall.installcustom.install_chromedriver
(dest_folder = ‘.’, fLOG = <built-in function print>, install = True, version = None)
Installs chromedriver.
pymyinstall.installcustom.install_git
(temp_folder = ‘.’, fLOG = <built-in function print>, install = True, force_download = False, version = None)
Install Git. It does not do it a second time if it is already installed.
pymyinstall.installcustom.install_graphviz
(temp_folder = ‘.’, fLOG = <built-in function print>, install = True, force_download = False, version = None, source = None)
Install Graphviz. It does not do it a second time if it is already installed.
pymyinstall.installcustom.install_inkscape
(dest_folder = ‘.’, fLOG = <built-in function print>, install = True, version = None)
Installs InkScape (only on Windows).
pymyinstall.installcustom.install_javajdk
(temp_folder = ‘.’, fLOG = <built-in function print>, install = True, force_download = False, version = None)
Install Java JDK.
pymyinstall.installcustom.install_jenkins
(dest_folder = ‘.’, fLOG = <built-in function print>, install = True, version = None)
install Jenkins (only on Windows)
pymyinstall.installcustom.install_julia
(temp_folder = ‘.’, fLOG = <built-in function print>, install = True, force_download = False, version = None)
Install R. It does not do it a second time if it is already installed.
pymyinstall.installcustom.install_miktex
(dest_folder = ‘.’, fLOG = <built-in function print>, install = True, version = None)
install MikTex (only on Windows)
pymyinstall.installcustom.install_mingw
(dest_folder = ‘.’, fLOG = <built-in function print>, install = True, version = None)
install MinGW (only on Windows)
pymyinstall.installcustom.install_operadriver
(dest_folder = ‘.’, fLOG = <built-in function print>, install = True, version = None)
Installs operadriver.
pymyinstall.installcustom.install_pandoc
(temp_folder = ‘.’, fLOG = <built-in function print>, install = True, force_download = False, version = None)
Install pandoc. It does not do it a second time if it is already installed.
pymyinstall.installcustom.install_putty
(dest_folder = ‘.’, fLOG = <built-in function print>, install = True, version = None)
install Putty (only on Windows)
pymyinstall.installcustom.install_python
(temp_folder = ‘.’, fLOG = <built-in function print>, install = True, force_download = False, version = None, modules = None, custom = False, latest = False, download_folder = ‘download’, verbose = False, make_first = False)
Installs python. It does not do it a second time if it is already installed.
pymyinstall.installcustom.install_R
(temp_folder = ‘.’, fLOG = <built-in function print>, install = True, force_download = False, version = None)
Install R. It does not do it a second time if it is already installed.
pymyinstall.installcustom.install_scite
(dest_folder = ‘.’, fLOG = <built-in function print>, install = True, change_python_path = False, version = None)
install SciTE (only on Windows)
pymyinstall.installcustom.install_sqlitespy
(temp_folder = ‘.’, fLOG = <built-in function print>, install = True, version = None, backup = False)
Installs SQLiteSpy. It does not do it a second time if it is already installed.
pymyinstall.installcustom.install_scala_sbt
(temp_folder = ‘.’, fLOG = <built-in function print>, install = True, force_download = False, version = None)
Install scala-sbt. It does not do it a second time if it is already installed.
pymyinstall.installcustom.modify_scite_properties
(python_path, scite_path)
modifies the scite properties
pymyinstall.installcustom.where_in_path
(name)
Looks for a file in current directory and in every path in
PATH
.