Skip to main content

Installation

Install the Bauplan CLI and SDK​

You can install Bauplan via pip. Ensure you are running a supported Python version (>=3.10):

pip install bauplan --upgrade

Verify the installation by checking the CLI version:

bauplan --version

Obtain Your API Key​

Sign in to your Bauplan account, navigate to your Settings → API Keys, and generate a new API key. If you do not have an API key yet, you can request one for free.

caution

Your API key is shown only once. Save it immediately in a secure location.

Configure Your API Key​

Set your API key directly in the Bauplan CLI:

bauplan config set api_key <your_api_key>

Verify your configuration:

bauplan config get

Option B: Configure via Python SDK​

When initializing the Bauplan client in your Python script or notebook, pass the API key directly as a string:

import bauplan

client = bauplan.Client(api_key="<your_api_key>")
danger

Never share your API key publicly. Store it securely using environment variables or secrets management tools in your deployment workflows.

Supported Environments and Constraints​

Bauplan officially supports Python 3.10 or higher. We recommend using a virtual environment (such as venv, virtualenv, or conda) for best practices and dependency management.