Installation Guide

  • Make sure to have Python 3.6+ installed (old version 2.x is not supported).

  • Create and activate a virtual environment (venv, pipenv, etc.)

  • Upgrade PyPI to the latest version

  • Install SPSDK

Windows

To install SPSDK under Windows follow:

python -m venv venv
venv\Scripts\activate
python -m pip install --upgrade pip
pip install spsdk
spsdk --help

SPSDK help for command-line applications should be displayed.

Note

In Windows OS you need to install Microsoft Visual C++ Build Tools

Linux

To install SPSDK under Linux follow:

python3 -m venv venv
source venv/bin/activate
python -m pip install --upgrade pip
pip install spsdk
spsdk --help

SPSDK help for command-line applications should be displayed.

macOS @ Intel

To install SPSDK under macOS follow:

python3 -m venv venv
source venv/bin/activate
python -m pip install --upgrade pip
pip install spsdk
spsdk --help

SPSDK help for command-line applications should be displayed.

macOS @ M1

It’s recommended to use the pyenv package for Python installation. To install SPSDK follow those steps:

  1. Install homebrew. Homebrew is a package manager for macOS located here

$ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

  1. Install pyenv

$ brew update
$ brew install pyenv

  1. Enable pyenv, execute the following lines to set environment variables, assuming you are using zsh

$ echo 'export PYENV_ROOT="$HOME/.pyenv"' >> ~/.zprofile
$ echo 'export PATH="$PYENV_ROOT/bin:$PATH"' >> ~/.zprofile

  1. Install Python

$ pyenv install 3.9.5

  1. Make pyenv Python global and rehash

$ pyenv global 3.9.5
$ pyenv rehash

Now you can use pip for package installation.

  1. Install rust compiler. To build some SPSDK dependencies a rust compiler is needed, to install it a rustup script could be used: https://rustup.rs.

$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

  1. Install Python build dependencies

$ brew install openssl readline sqlite3 xz zlib

  1. Export compiler flags for openssl

$ export LDFLAGS="-L/opt/homebrew/opt/openssl@1.1/lib"
$ export CPPFLAGS="-I/opt/homebrew/opt/openssl@1.1/include"

  1. Install SPSDK

$ pip install spsdk

GitHub

To install SPSDK form GitHub follow:

$ pip install -U https://github.com/NXPmicro/spsdk/archive/master.zip

GitHub - from sources

To install SPSDK from source code follow:

$ git clone https://github.com/NXPmicro/spsdk.git
$ cd spsdk
$ pip install -U -e .

Note

In case of problems during installation, please make sure that you have the latest pip version. You can upgrade pip using this command:

pip install --upgrade pip