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

Common Command Pattern

On the Datazone CLI, generally, the command pattern is as follows:

datazone <entity> <action> [options]

Help

You can get help about the Datazone CLI commands by add --help flag to the command.

datazone --help
datazone project --help
datazone dataset list --help

Commands

profile

## Create a new profile. It will ask you some questions to create a new profile.
datazone profile create

## List all profiles
datazone profile list

## Delete a profile
datazone profile delete <profile-name>

## Set default profile
datazone profile set-default <profile-name>

source

## List all sources
datazone source list

## Create a new source. It will ask you some questions to create a new source.
datazone source create

## Delete a source
datazone source delete <source-id>

project

## List all projects
datazone project list

## Create a new project
datazone project create <project-name>

## Clone a project
datazone project clone <project-id>

## Deploy a project
datazone project deploy [--commit-message <message>] [--file <file-path>]

## Pull the project
datazone project pull

## Show the summary of the project
datazone project summary

dataset

## List all datasets
datazone dataset list

## Show sample data of a dataset
datazone dataset show <dataset-id>

## List all transactions of a dataset
datazone dataset transactions <dataset-id>

pipeline

## Create a new pipeline
datazone pipeline create

extract

## Create a new extract
datazone extract create

## List all extract
datazone extract list

## Delete an extract
datazone extract delete <extract-id>

## Run an execution for an extract
datazone extract execute <extract-id>

execution

## List all executions
datazone execution list

## Show logs of an execution
datazone execution logs <execution-id>

## Run an execution
datazone execution run [--extract-id <extract-id>] [--pipeline-id <pipeline-id>]

auth

## Login to Datazone. If you lost your session, the other commands will attempt to login automatically.
datazone auth login

version

## Show the version of the Datazone CLI
datazone version

info

## Show the information of the current session
datazone info