.. _f-moduleinstall: module ``installhelper.module_install`` ======================================= .. inheritance-diagram:: pymyinstall.installhelper.module_install Short summary +++++++++++++ module ``pymyinstall.installhelper.module_install`` Various function to install various python module from various location. :githublink:`%|py|5` Classes +++++++ +---------------------------------------------------------------------------------+------------------------------------------------+ | class | truncated documentation | +=================================================================================+================================================+ | :class:`ModuleInstall ` | defines the necessary information for a module | +---------------------------------------------------------------------------------+------------------------------------------------+ Functions +++++++++ +------------------------------------------------------------------------------------+-------------------------+ | function | truncated documentation | +====================================================================================+=========================+ | :func:`_filter_pip_out ` | | +------------------------------------------------------------------------------------+-------------------------+ Properties ++++++++++ +----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | property | truncated documentation | +========================================================================================+===============================================================================+ | :meth:`ImportName ` | return the import name | +----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :meth:`Purpose ` | returns the comment | +----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :meth:`Script ` | returns the script to run if the extension is an application and not a module | +----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ Static Methods ++++++++++++++ +------------------------------------------------------------------------------------------+-----------------------------------------+ | staticmethod | truncated documentation | +==========================================================================================+=========================================+ | :meth:`clear_cache ` | clear the local cache to get wheel link | +------------------------------------------------------------------------------------------+-----------------------------------------+ | :meth:`is_annoying ` | some modules are not available on pipy | +------------------------------------------------------------------------------------------+-----------------------------------------+ Methods +++++++ +------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ | method | truncated documentation | +==============================================================================================================================+=================================================================================================================+ | :py:meth:`__cmp__ ` | to sort modules | +------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | | +------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ | :py:meth:`__lt__ ` | overload operator ``<`` | +------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ | :py:meth:`__repr__ ` | usual | +------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ | :py:meth:`__str__ ` | usual | +------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ | :py:meth:`_check_installation ` | some modules uninstall and install modules with another version number, we try to track that | +------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ | :meth:`as_dict ` | returns the members in a dictionary | +------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ | :meth:`copy ` | copy the module, if version is not None, change the version number | +------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ | :meth:`download ` | Downloads the module without installation. | +------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ | :meth:`extract_version ` | extract the version from a filename | +------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ | :meth:`get_exewheel_url_link ` | for windows, get the url of the setup using a webpage | +------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ | :meth:`get_exewheel_url_link2 ` | for windows, get the url of the setup using a webpage | +------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ | :meth:`get_installed_classifier ` | return the classifier of the installed package | +------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ | :meth:`get_installed_license ` | return the license of the installed package | +------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ | :meth:`get_installed_metadata ` | return the metadata of the installed package | +------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ | :meth:`get_installed_numeric_version ` | returns the version as number (not string) | +------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ | :meth:`get_installed_version ` | return the version of the installed package | +------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ | :meth:`get_pypi_numeric_version ` | returns the version of a package in pypi | +------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ | :meth:`get_pypi_version ` | returns the version of a package on pypi | +------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ | :meth:`has_update ` | tells if the package has a newer version on pipy | +------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ | :meth:`install ` | Installs the package. | +------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ | :meth:`is_installed_local ` | checks if a module is installed | +------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ | :meth:`is_installed_local_cmd ` | Test the module by running a command line. Does some others verifications for a specific modules such as scipy. | +------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ | :meth:`is_installed_version ` | tells if a module is installed | +------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ | :meth:`module_install_preprocess ` | Run some preprocessing for specific modules | +------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ | :meth:`run_post_installation ` | Run instructions post installation | +------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ | :meth:`unzipfiles ` | unzip files from a zip archive | +------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ | :meth:`update ` | Updates the package if necessary, we use ``pip install --upgrade --no-deps``, | +------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ Documentation +++++++++++++ .. automodule:: pymyinstall.installhelper.module_install :members: :special-members: __init__ :show-inheritance: