How to use own python libraries in extra_script.py

maxgerhardt · November 12, 2020, 9:13pm

If you do a pip install in the MacOS terminal, that will add it to the Python 2.7 libraries, as that is what MacOS is using. When installing PlatformIO via VSCode, it brings its own self-contained Python3 environment which is separate from the system environment. The libs installed by your system’s pip will not be seen there.

The recommended way to install additional Python dependencies is to attempt an import, and if that fails, call into $PYTHONEXE -m pip install <package> to install it. This is showcased e.g. in

github.com

platformio/platform-espressif32/blob/07919d0c5a731b06f01513766be0e72da38db313/builder/frameworks/espidf.py#L74-L97


      
          try:
              import future
              import pyparsing
              import cryptography
          except ImportError:
              env.Execute(
                  env.VerboseAction(
                      '$PYTHONEXE -m pip install "cryptography>=2.1.4" "future>=0.15.2" "pyparsing>=2.0.3,<2.4.0" ',
                      "Installing ESP-IDF's Python dependencies",
                  )
              )
          
          # a special "esp-windows-curses" python package is required on Windows for Menuconfig
          if "windows" in get_systype():
              import pkg_resources
          
              if "esp-windows-curses" not in {pkg.key for pkg in pkg_resources.working_set}:
                  env.Execute(
                      env.VerboseAction(
                          '$PYTHONEXE -m pip install "file://%s/tools/kconfig_new/esp-windows-curses" windows-curses'

This file has been truncated. show original

and you should add the same style of code in your extra script.

For a more direct way, you can also go into your home directory (/Users/<user> on Mac, idk?) and from there into the .platformio folder. Search this folder for the pip3 executable. Once you find its path, use this pip3 executable to execute the install command, and it will be installed. This is then however not well reproducable accross computers because every user of your extra script will have to do this too; Prefer the first method instead.