​
Requirements

Use the following command to check that you have a supported Python version installed:

python --version

Currently, Python 3.8, 3.9, 3.10, 3.11 and 3.12 are supported

​
Installation

  • You can install the Datazone Python SDK using pip:
pip install datazone
  • Check that the installation was successful by running the following command:
datazone --version

Check Datazone CLI section for more information on how to use the CLI.

​
Get API Key

To use the Datazone CLI, you need to create an API key. You can do this by following these steps:

  1. Go to the Settings page by clicking on the Settings tab in the sidebar.
  2. Click on the API Keys tab in the left sidebar.
  3. Click on the +Create button.

​
Login via CLI

If you have already created an account, you can log in to the Datazone CLI using the following command:

datazone profile create
> Profile [default]: <your-profile-name>
> Host [app.datazone.co]: <your-host> (If you are using a self-hosted version)
> API Key: <api-key>
> Password: <your-password>
> Repeat for confirmation: <your-password>

You logged in successfully 🎉

After you have successfully logged in, you can start using the Datazone CLI to interact with the Datazone API. You can check you session status by running the following command:

datazone project list

For more information on how to use the Datazone CLI, check the Command Line section.