Skip to main content
Version: 0.4.0

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

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
  1. Next, download Homebrew from their website.

  2. 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

Setting up a virtual environment

You can create virtual environments using venv or Conda.

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

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.

pip3 install seaplane

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

The Seaplane CLI supports the following commands.

  • build - Builds an application when executed inside a Seaplane project directory.
  • deploy - Deploys an application when executed inside a Seaplane project directory.
  • destroy - Destroy an application i.e delete all cloud infrastructure associated with this application with the exception of persistent data stores.
  • init - Initialize a new Seaplane project.
  • version - Returns the current version of the Seaplane CLI and package.