Before you can create a self-service Tetra Data Pipeline (SSP), you must do the following:

• Initialize a TetraScience Development Environment
• Initialize the TetraScience Command Line Interface (CLI)
• Configure Tetra Data Platform (TDP) dependencies and authentication
• Initialize the TetraScience SDK (recommended, not required)

📘

NOTE

The following prerequisites are also required for creating Tetraflow artifacts in the Data Lakehouse.

Important Considerations

As you set up your development environment, keep in mind the following:

• Python is the only supported programming language that you can use to write SSPs. We recommend using pyenv if you have to work with multiple versions on the same machine.
• You can choose which Python version a task script uses by adding a "runtime" parameter to the script's config.json file. Python versions 3.7, 3.8, 3.9, 3.10, and 3.11 are supported currently. For more information, see config.json Files.
• The following procedure shows how to initialize the TetraScience Development Tools in a single, basic Python development environment. It's recommended that you use a Python package manager, such as pipx or uv, to initialize these tools in more complex development environments.

Initialize a TetraScience Development Environment

To initialize a TetraScience development environment, do the following:

1. Install Python (versions 3.7 through 3.11 are supported currently)

2. Install the poetry package by running the following command:

   pip3 install poetry

3. Install the poetry-plugin-export package by running the following command:

   poetry self add poetry-plugin-export

Initialize the TetraScience CLI

To initialize the TetraScience Command Line Interface (CLI), do the following:

1. Install the tetrascience-cli package by running the following command:

   pip3 install tetrascience-cli

2. Verify the installation was successful by running the following command:

   ts-cli --help

Configure TDP Dependencies and Authentication

To configure the required Tetra Data Platform (TDP) dependencies and authentication credentials, do the following:

1. Sign in to the TDP as an admin user.
2. Create a Service User account with admin access on the Organization Settings page in your profile (or use an existing one).
3. Create a JSON Web Token (JWT) for the Service User that you've selected.
4. Create an auth.json file (you can select a different name) at any location you want. You can also download this file from the previous step by selecting the Download ts-sdk config button on the token creation dialog. You will use this file later in the ts-cli publish command by adding -c path/to/auth.json to the command line.

Exampleauth.json File

{
    "api_url":"<TDP API endpoint base URL>",
    "auth_token":"<service token you generated>",
    "org":"<your organization slug name>",
    "ignore_ssl": <true to allow invalid SSL certificates>
}

Initialize the TetraScience SDK (Optional)

The TetraScience Software Development Kit (SDK) is an optional tool that you can use to test SSP artifacts locally. Testing SSP artifacts locally can help reduce development time and catch issues before the artifacts are deployed to production.

To initialize the TetraScience SDK, do the following:

1. Install the ts-sdk package by running the following command:

   pip3 install "ts-sdk[testing]"

2. Verify the installation was successful by running the following command:

   ts-sdk --help

Documentation Feedback

Do you have questions about our documentation or suggestions for how we can improve it? Start a discussion in TetraConnect Hub. For access, see Access the TetraConnect Hub.

📘

NOTE

Feedback isn't part of the official TetraScience product documentation. TetraScience doesn't warrant or make any guarantees about the feedback provided, including its accuracy, relevance, or reliability. All feedback is subject to the terms set forth in the TetraConnect Hub Community Guidelines.