SDK Installation

This document describes how to download, install and setup the Seaplane SDK.

To get started, we have provided instructions to install Python and pip. Seaplane requires Python 3.10 or higher.

We have provided instructions to set up a virtual environment. We recommend you do this to avoid dependency conflicts.

If you want to quickly get started, have a look at the quick start guide instead.

Installing Python and pip

Unix/macOS

By default, Python 2.7 is installed on Mac. You will need to upgrade to Python 3.10 to use the Seaplane SDK:

1. Open Terminal to get started.

2. You need Mac build tools, which you will be prompted to install or you can run the following command:

xcode-select --install

3. Next, download Homebrew from their website.

4. Install Python3 by running this command in Terminal:

brew install python

You can check that Python 3.10 is installed by running:

python3 --version

Homebrew installs pip for you. You can check pip is installed by running:

pip --version

Windows

You need to install Python 3.10 or higher:

1. Download the latest version of Python on their website.

2. Follow the setup instructions to install the .exe file.

3. Check that Python3 is installed by running this command in Windows cmd:

python3 -version

Setting up a virtual environment

You can create virtual environments using venv or Conda.

Unix/macOS

Venv

python3 -m venv my-seaplane-project
source my-seaplane-project/bin/activate

Conda

conda env create -n seaplane python=3.10
conda activate seaplane

Windows

Venv

py -m venv my-seaplane-project
.\my-seaplane-project\Scripts\activate

Conda

You can download Anaconda on their website.

Follow the set up instructions to install Python3 version.

To activate conda, open up Command Prompt and run:

conda activate C:\<conda_path>

tip

You can learn more about virtual environments in the venv or Conda documentation.

Seaplane SDK Installation and Commands

With your virtual environment activated, run the following command to install the Seaplane SDK. This installs both the Seaplane package as well as the Seaplane CLI tool.

Unix/macOS

pip3 install seaplane

Windows

py -m pip install seaplane

Depending on your Windows version and how you installed Python you might have to add the Python scripts directory to your path; i.e add the following line C:\Users\<username>\AppData\Local\Programs\Python\Python311\Scripts to your system path. Make sure to replace <username> with your username and make sure to check the path to your Python install directory. Depending on how you installed Python the directory path might differ slightly. Ensure that the Scripts directory is listed above your installed Python version. You can move lines up and down using the Move Up and Move Down buttons on the right side.

Linux

pip install seaplane

After installing, run seaplane --help to confirm that the installation was successful and to show the available commands.

Learn more about Seaplane's CLI here.