Warning

Most of the documentation was written prior to version 0.5 and needs to be updated. This work has now started for version 0.7 and we aim to have it completed before version 0.8 is available.

Tip

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

Getting Friendly

You can get Friendly from PyPI in the usual way:

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.

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