.. _f-installvenvhelper:

module ``installhelper.install_venv_helper``
============================================





.. inheritance-diagram:: pymyinstall.installhelper.install_venv_helper


Short summary
+++++++++++++

module ``pymyinstall.installhelper.install_venv_helper``

Helpers for virtualenv


:githublink:`%|py|5`




Classes
+++++++

+------------------------------------------------------------------------------------------+-----------------------------------------------------------+
| class                                                                                    | truncated documentation                                   |
+==========================================================================================+===========================================================+
| :class:`VirtualEnvError <pymyinstall.installhelper.install_venv_helper.VirtualEnvError>` | exception raised by the function implemented in this file |
+------------------------------------------------------------------------------------------+-----------------------------------------------------------+




Functions
+++++++++

+-----------------------------------------------------------------------------------------------+--------------------------------------------------------------------+
| function                                                                                      | truncated documentation                                            |
+===============================================================================================+====================================================================+
| :func:`build_venv_cmd <pymyinstall.installhelper.install_venv_helper.build_venv_cmd>`         | builds the command line for virtual env                            |
+-----------------------------------------------------------------------------------------------+--------------------------------------------------------------------+
| :func:`create_virtual_env <pymyinstall.installhelper.install_venv_helper.create_virtual_env>` |                                                                    |
+-----------------------------------------------------------------------------------------------+--------------------------------------------------------------------+
| :func:`run_cmd_path <pymyinstall.installhelper.install_venv_helper.run_cmd_path>`             | run a script knowing python path, it does not raise an exception.  |
+-----------------------------------------------------------------------------------------------+--------------------------------------------------------------------+
| :func:`run_venv_script <pymyinstall.installhelper.install_venv_helper.run_venv_script>`       | run a script on a virtual environment (the script should be simple |
+-----------------------------------------------------------------------------------------------+--------------------------------------------------------------------+
| :func:`venv_install <pymyinstall.installhelper.install_venv_helper.venv_install>`             | install a package or a list of packages in a virtual environment   |
+-----------------------------------------------------------------------------------------------+--------------------------------------------------------------------+








Documentation
+++++++++++++

.. automodule:: pymyinstall.installhelper.install_venv_helper
    :members:
    :special-members: __init__
    :show-inheritance: