.. _f-venvhelper:

module ``pycode.venv_helper``
=============================





.. inheritance-diagram:: pyquickhelper.pycode.venv_helper


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

module ``pyquickhelper.pycode.venv_helper``

Helpers for virtualenv


:githublink:`%|py|5`




Classes
+++++++

+---------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
| class                                                                                                                           | truncated documentation                                                      |
+=================================================================================================================================+==============================================================================+
| :class:`NotImplementedErrorFromVirtualEnvironment <pyquickhelper.pycode.venv_helper.NotImplementedErrorFromVirtualEnvironment>` | Defines an exception when a function does not work in a virtual environment. |
+---------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
| :class:`VirtualEnvError <pyquickhelper.pycode.venv_helper.VirtualEnvError>`                                                     | Exception raised by the function implemented in this file.                   |
+---------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+




Functions
+++++++++

+------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
| function                                                                                 | truncated documentation                                                                             |
+==========================================================================================+=====================================================================================================+
| :func:`build_venv_cmd <pyquickhelper.pycode.venv_helper.build_venv_cmd>`                 | Builds the command line for virtual env.                                                            |
+------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
| :func:`check_readme_syntax <pyquickhelper.pycode.venv_helper.check_readme_syntax>`       | Checks the syntax of the file ``readme.rst`` which describes a python project.                      |
+------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
| :func:`create_virtual_env <pyquickhelper.pycode.venv_helper.create_virtual_env>`         | Creates a virtual environment.                                                                      |
+------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
| :func:`is_virtual_environment <pyquickhelper.pycode.venv_helper.is_virtual_environment>` | Tells if the script is run from a virtual environment.                                              |
+------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
| :func:`run_base_script <pyquickhelper.pycode.venv_helper.run_base_script>`               | Runs a script with the original intepreter even if this function is run from a virtual environment. |
+------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
| :func:`run_venv_script <pyquickhelper.pycode.venv_helper.run_venv_script>`               | Runs a script on a vritual environment (the script should be simple).                               |
+------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
| :func:`venv_install <pyquickhelper.pycode.venv_helper.venv_install>`                     | Installs a package or a list of packages in a virtual environment.                                  |
+------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+








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

.. automodule:: pyquickhelper.pycode.venv_helper
    :members:
    :special-members: __init__
    :show-inheritance: