.. _f-piphelper:

module ``pycode.pip_helper``
============================





.. inheritance-diagram:: pyquickhelper.pycode.pip_helper


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

module ``pyquickhelper.pycode.pip_helper``

Helpers for pip

Some links to look:

* `installing_python_packages_programatically.py <https://gist.github.com/rwilcox/755524>`_
* `Calling pip programmatically <http://blog.ducky.io/python/2013/08/22/calling-pip-programmatically/>`_


:githublink:`%|py|10`




Classes
+++++++

+----------------------------------------------------------------------+--------------------------------------------------------+
| class                                                                | truncated documentation                                |
+======================================================================+========================================================+
| :class:`Distribution <pyquickhelper.pycode.pip_helper.Distribution>` | Common interface for old and recent pip packages.      |
+----------------------------------------------------------------------+--------------------------------------------------------+
| :class:`PQPipError <pyquickhelper.pycode.pip_helper.PQPipError>`     | Any exception raised by one of the following function. |
+----------------------------------------------------------------------+--------------------------------------------------------+




Functions
+++++++++

+---------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| function                                                                                          | truncated documentation                                                                                                       |
+===================================================================================================+===============================================================================================================================+
| :func:`get_installed_distributions <pyquickhelper.pycode.pip_helper.get_installed_distributions>` | Directs call to function *get_installed_distributions* from :epkg:`pip`. Return a list of installed Distribution objects. ... |
+---------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :func:`get_package_info <pyquickhelper.pycode.pip_helper.get_package_info>`                       | Calls ``pip show`` to retrieve information about packages.                                                                    |
+---------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :func:`get_packages_list <pyquickhelper.pycode.pip_helper.get_packages_list>`                     | calls ``pip list`` to retrieve the list of packages                                                                           |
+---------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :func:`package2dict <pyquickhelper.pycode.pip_helper.package2dict>`                               | Extracts information from a package.                                                                                          |
+---------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+








Methods
+++++++

+-----------------------------------------------------------------------------------+-------------------------+
| method                                                                            | truncated documentation |
+===================================================================================+=========================+
| :py:meth:`__getattr__ <pyquickhelper.pycode.pip_helper.Distribution.__getattr__>` |                         |
+-----------------------------------------------------------------------------------+-------------------------+
| :py:meth:`__init__ <pyquickhelper.pycode.pip_helper.Distribution.__init__>`       |                         |
+-----------------------------------------------------------------------------------+-------------------------+
| :py:meth:`__init__ <pyquickhelper.pycode.pip_helper.PQPipError.__init__>`         |                         |
+-----------------------------------------------------------------------------------+-------------------------+


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

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