.. tip::

    |mu_logo| If you use Mu, you should ignore this page as some
    Mu-specific instructions are provided later.

.. |mu_logo| image:: images/mu_logo.png

Getting Friendly
=================


You can get **Friendly** from `PyPI <https://pypi.org/>`_ in the usual way:

.. code-block:: none

    python -m pip install friendly



This needs to be done from a terminal.
In the command shown above,
``python`` refers to whatever you need to type to invoke your
favourite Python interpreter.
It could be ``python``, ``python3``, ``py -3.8``, etc.

Instead of ``python -m pip install ...``, some tutorials might suggest
to simply write ``pip install ...``; I do not recommend this as it might
not install programs in the right "environment" for your computer.


.. tip::

    Installing **friendly** with pip automatically installs **friendly_traceback**.
    Unless you have a specific use case that requires
    to use **friendly_traceback** directly,
    you should use **friendly**.


.. caution::

    A mistake often made by beginners is
    to try to use ``pip`` from within Python.

    .. image:: images/pip2.png
       :scale: 50 %
       :alt: error using pip inside a Python console

    The error message is not very helpful.
    This is what it might look if you had already been using **friendly**.


    .. image:: images/pip.png
       :scale: 50 %
       :alt: error using pip inside a friendly console