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:
Open Terminal to get started.
You need Mac build tools, which you will be prompted to install or you can run the following command:
Next, download Homebrew from their website.
Install Python3 by running this command in Terminal:
brew install python
You can check that Python 3.10 is installed by running:
Homebrew installs pip for you. You can check pip is installed by running:
You need to install Python 3.10 or higher:
Download the latest version of Python on their website.
Follow the setup instructions to install the .exe file.
Check that Python3 is installed by running this command in Windows cmd:
Setting up a virtual environment
You can create virtual environments using venv or Conda.
python3 -m venv my-seaplane-project
conda env create -n seaplane python=3.10
conda activate seaplane
py -m venv my-seaplane-project
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>
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
py -m pip install seaplane
pip 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.