.. _l-modules:

Modules
=======

+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| module                                                                                                                             | truncated documentation                                                                                                                                                                                                                                                                                                                                                                               |
+====================================================================================================================================+=======================================================================================================================================================================================================================================================================================================================================================================================================+
| :ref:`__init__ <f-init>`                                                                                                           | module ``pymyinstall``    Documentation for this file.    To install a list of modules for a machine learner:::        from pymyinstall import complete_installation, install_scite, install_pandoc, open_tool_on_browser      for _ in complete_installation() :          _.install(temp_folder="install")      install_scite("install")      install_pandoc("install")      open_tool_on_browser()  |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initz>`                                                                                                          | module ``pymyinstall.installhelper``    Shortuts                                                                                                                                                                                                                                                                                                                                                      |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzz>`                                                                                                         | module ``pymyinstall.packaged``    Shortcuts to packaged                                                                                                                                                                                                                                                                                                                                              |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzzz>`                                                                                                        | module ``pymyinstall.win_installer``    @breif shortcuts to win_installer                                                                                                                                                                                                                                                                                                                             |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`automate_install <f-automateinstall>`                                                                                        | module ``pymyinstall.packaged.automate_install``    Install or update all packages.                                                                                                                                                                                                                                                                                                                   |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`get_pip <f-getpip>`                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                       |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`import_pywin32 <f-importpywin32>`                                                                                            | module ``pymyinstall.win_installer.import_pywin32``    @grief Functions to help using pywin32.                                                                                                                                                                                                                                                                                                        |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`install_cmd_helper <f-installcmdhelper>`                                                                                     | module ``pymyinstall.installhelper.install_cmd_helper``    Various function to install various python module from various location.                                                                                                                                                                                                                                                                   |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`install_custom <f-installcustom>`                                                                                            | module ``pymyinstall.installhelper.install_custom``    Various functions to install some application such as `pandoc <http://johnmacfarlane.net/pandoc/>`_.                                                                                                                                                                                                                                           |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`install_custom_7z <f-installcustom7z>`                                                                                       | module ``pymyinstall.installhelper.install_custom_7z``    Various functions to install some applications such as `7z <http://www.7-zip.org/>`_.                                                                                                                                                                                                                                                       |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`install_custom_R <f-installcustomR>`                                                                                         | module ``pymyinstall.installhelper.install_custom_R``    Various functions to install `R <http://www.r-project.org/>`_.                                                                                                                                                                                                                                                                               |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`install_custom_julia <f-installcustomjulia>`                                                                                 | module ``pymyinstall.installhelper.install_custom_julia``    Various functions to install `Julia <http://www.julialang.org/>`_.                                                                                                                                                                                                                                                                       |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`install_custom_mingw <f-installcustommingw>`                                                                                 | module ``pymyinstall.installhelper.install_custom_mingw``    Various functions to install `MinGW <http://www.mingw.org/>`_.                                                                                                                                                                                                                                                                           |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`install_custom_pandoc <f-installcustompandoc>`                                                                               | module ``pymyinstall.installhelper.install_custom_pandoc``    Various functions to install some application such as `pandoc <http://johnmacfarlane.net/pandoc/>`_.                                                                                                                                                                                                                                    |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`install_custom_python <f-installcustompython>`                                                                               | module ``pymyinstall.installhelper.install_custom_python``    Various functions to install `python <http://www.python.org/>`_.                                                                                                                                                                                                                                                                        |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`install_custom_revealjs <f-installcustomrevealjs>`                                                                           | module ``pymyinstall.installhelper.install_custom_revealjs``    Various functions to install `reveal.js <https://github.com/hakimel/reveal.js/releases>`_.                                                                                                                                                                                                                                            |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`install_custom_scite <f-installcustomscite>`                                                                                 | module ``pymyinstall.installhelper.install_custom_scite``    Various functions to install `SciTE <http://www.scintilla.org/SciTE.html>`_.                                                                                                                                                                                                                                                             |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`install_custom_sqlitespy <f-installcustomsqlitespy>`                                                                         | module ``pymyinstall.installhelper.install_custom_sqlitespy``    Various functions to install `SQLiteSpy <http://www.yunqa.de/delphi/doku.php/products/sqlitespy/index>`_.                                                                                                                                                                                                                            |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`install_custom_vs <f-installcustomvs>`                                                                                       | module ``pymyinstall.installhelper.install_custom_vs``    Various functions to install `MinGW <http://www.mingw.org/>`_.                                                                                                                                                                                                                                                                              |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`install_manual <f-installmanual>`                                                                                            | module ``pymyinstall.installhelper.install_manual``    Contains a list of web site with some useful tools.                                                                                                                                                                                                                                                                                            |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`install_memoize <f-installmemoize>`                                                                                          | module ``pymyinstall.installhelper.install_memoize``    Caching functions                                                                                                                                                                                                                                                                                                                             |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`install_venv_helper <f-installvenvhelper>`                                                                                   | module ``pymyinstall.installhelper.install_venv_helper``    Helpers for virtualenv                                                                                                                                                                                                                                                                                                                    |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`ipython_helper <f-ipythonhelper>`                                                                                            | module ``pymyinstall.setuphelper.ipython_helper``    Change ipython configuration                                                                                                                                                                                                                                                                                                                     |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`link_shortcuts <f-linkshortcuts>`                                                                                            | module ``pymyinstall.installhelper.link_shortcuts``    Various helper about shortcuts and links                                                                                                                                                                                                                                                                                                       |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`module_install <f-moduleinstall>`                                                                                            | module ``pymyinstall.installhelper.module_install``    Various function to install various python module from various location.                                                                                                                                                                                                                                                                       |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`packaged_config <f-packagedconfig>`                                                                                          | module ``pymyinstall.packaged.packaged_config``    Defines different set of modules to install.                                                                                                                                                                                                                                                                                                       |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`packaged_config_full_set <f-packagedconfigfullset>`                                                                          | module ``pymyinstall.packaged.packaged_config_full_set``    Defines different set of modules to install.                                                                                                                                                                                                                                                                                              |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`requirements <f-requirements>`                                                                                               | module ``pymyinstall.installhelper.requirements``    helpers around requirements                                                                                                                                                                                                                                                                                                                      |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`win_batch <f-winbatch>`                                                                                                      | module ``pymyinstall.win_installer.win_batch``    Creates batch file to set up the environment                                                                                                                                                                                                                                                                                                        |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`win_exception <f-winexception>`                                                                                              | module ``pymyinstall.win_installer.win_exception``    Helpers, inspired from `utils.py <https://github.com/winpython/winpython/blob/master/winpython/utils.py>`_                                                                                                                                                                                                                                      |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`win_extract <f-winextract>`                                                                                                  | module ``pymyinstall.win_installer.win_extract``    Helpers, inspired from `utils.py <https://github.com/winpython/winpython/blob/master/winpython/utils.py>`_                                                                                                                                                                                                                                        |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`win_fix_compiler_c <f-winfixcompilerc>`                                                                                      | module ``pymyinstall.win_installer.win_fix_compiler_c``    Various to set up a C++ compiler                                                                                                                                                                                                                                                                                                           |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`win_helper <f-winhelper>`                                                                                                    | module ``pymyinstall.win_installer.win_helper``    Helpers, inspired from `utils.py <https://github.com/winpython/winpython/blob/master/winpython/utils.py>`_                                                                                                                                                                                                                                         |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`win_innosetup_helper <f-wininnosetuphelper>`                                                                                 | module ``pymyinstall.win_installer.win_innosetup_helper``    Functions to prepare a setup on Windows, use InnoSetup                                                                                                                                                                                                                                                                                   |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`win_ipy_kernels <f-winipykernels>`                                                                                           | module ``pymyinstall.win_installer.win_ipy_kernels``    Functions to prepare a setup on Windows, R functions                                                                                                                                                                                                                                                                                          |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`win_ipython_helper <f-winipythonhelper>`                                                                                     | module ``pymyinstall.win_installer.win_ipython_helper``    Functions to prepare a setup on Windows                                                                                                                                                                                                                                                                                                    |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`win_packages <f-winpackages>`                                                                                                | module ``pymyinstall.win_installer.win_packages``    To install packages for a specific distribution.                                                                                                                                                                                                                                                                                                 |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`win_patch <f-winpatch>`                                                                                                      | module ``pymyinstall.win_installer.win_patch``    Patch the distribution to make it portable                                                                                                                                                                                                                                                                                                          |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`win_setup_julia <f-winsetupjulia>`                                                                                           | module ``pymyinstall.win_installer.win_setup_julia``    Functions to prepare a setup on Windows, R functions                                                                                                                                                                                                                                                                                          |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`win_setup_main <f-winsetupmain>`                                                                                             | module ``pymyinstall.win_installer.win_setup_main``    Functions to prepare a setup on Windows                                                                                                                                                                                                                                                                                                        |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`win_setup_main_helper <f-winsetupmainhelper>`                                                                                | module ``pymyinstall.win_installer.win_setup_main_helper``    Helpers for function :func:`win_python_setup`                                                                                                                                                                                                                                                                                           |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`win_setup_mark_step <f-winsetupmarkstep>`                                                                                    | module ``pymyinstall.win_installer.win_setup_mark_step``    Functions to remember a step was done, uses files.                                                                                                                                                                                                                                                                                        |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`win_setup_r <f-winsetupr>`                                                                                                   | module ``pymyinstall.win_installer.win_setup_r``    Functions to prepare a setup on Windows, R functions                                                                                                                                                                                                                                                                                              |
+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+


.. toctree::
    :maxdepth: 1

    pymyinstall/__init__
    pymyinstall/installhelper/__init__
    pymyinstall/installhelper/get_pip
    pymyinstall/installhelper/install_cmd_helper
    pymyinstall/installhelper/install_custom
    pymyinstall/installhelper/install_custom_7z
    pymyinstall/installhelper/install_custom_R
    pymyinstall/installhelper/install_custom_julia
    pymyinstall/installhelper/install_custom_mingw
    pymyinstall/installhelper/install_custom_pandoc
    pymyinstall/installhelper/install_custom_python
    pymyinstall/installhelper/install_custom_revealjs
    pymyinstall/installhelper/install_custom_scite
    pymyinstall/installhelper/install_custom_sqlitespy
    pymyinstall/installhelper/install_custom_vs
    pymyinstall/installhelper/install_manual
    pymyinstall/installhelper/install_memoize
    pymyinstall/installhelper/install_venv_helper
    pymyinstall/installhelper/link_shortcuts
    pymyinstall/installhelper/module_install
    pymyinstall/installhelper/requirements
    pymyinstall/packaged/__init__
    pymyinstall/packaged/automate_install
    pymyinstall/packaged/packaged_config
    pymyinstall/packaged/packaged_config_full_set
    pymyinstall/setuphelper/ipython_helper
    pymyinstall/win_installer/__init__
    pymyinstall/win_installer/import_pywin32
    pymyinstall/win_installer/win_batch
    pymyinstall/win_installer/win_exception
    pymyinstall/win_installer/win_extract
    pymyinstall/win_installer/win_fix_compiler_c
    pymyinstall/win_installer/win_helper
    pymyinstall/win_installer/win_innosetup_helper
    pymyinstall/win_installer/win_ipy_kernels
    pymyinstall/win_installer/win_ipython_helper
    pymyinstall/win_installer/win_packages
    pymyinstall/win_installer/win_patch
    pymyinstall/win_installer/win_setup_julia
    pymyinstall/win_installer/win_setup_main
    pymyinstall/win_installer/win_setup_main_helper
    pymyinstall/win_installer/win_setup_mark_step
    pymyinstall/win_installer/win_setup_r