Skip to main content

Installing on macOS

This guide will help you install the Groundlight SDK on macOS. The Groundlight SDK requires Python 3.9 or higher.

Prerequisites​

Ensure that you have the following installed on your system:

  • Python 3.9 or higher
  • pip (Python package installer)

Basic Installation​

Assuming you have Python 3.9 or higher installed on your system, you can proceed with the following steps to install or upgrade the Groundlight SDK:

Installing Groundlight SDK​

To install the Groundlight SDK using pip, run the following command in your terminal:

pip install groundlight

If you're also using python2 on your system, you might need to use pip3 instead:

pip3 install groundlight

The Groundlight SDK is now installed and ready for use.

Checking Groundlight SDK Version​

To check if the Groundlight SDK is installed and to display its version, you can use the following Python one-liner:

python -c "import groundlight; print(groundlight.__version__)"

or the groundlight command line tool that comes with the SDK:

groundlight --help

Upgrading Groundlight SDK​

If you need to upgrade the Groundlight SDK to the latest version, use the following pip command:

pip install --upgrade groundlight

Or, if you're using pip3:

pip3 install --upgrade groundlight

After upgrading, you can use the Python one-liner mentioned in the "Checking Groundlight SDK Version" section to verify that the latest version is now installed.

Getting the right Python Version​

To check your installed Python version, open a terminal and run:

python --version

If you see a version number starting with "3.9" or higher (e.g., "3.9.5" or "3.9.0"), you're good to go. If not, you might need to upgrade Python on your system.

Upgrading Python on MacOS​

Download the latest Python installer from the official Python website and run it, or use Homebrew to install Python:

brew install python

After upgrading, verify the Python version by running python --version or python3 --version, as described earlier.

Ready to go!​

You're now ready to start using the Groundlight SDK in your projects. For more information on using the SDK, refer to the API Tokens documentation and the Building Applications Guide.