Installation

This guide covers how to install and configure DataIO for both SDK and CLI usage.

Installing DataIO

dataio is available on PyPI. The latest version is 0.4.0b13.

Using uv:

uv add dataio-artpark

or using pip:

venv .venv
source .venv/bin/activate
pip install dataio-artpark

It is always recommended to use a virtual environment to install the package, regardless of the installation method. uv provides a seamless way to create and manage virtual environments within the same command.

You can also install it from source:

uv install https://github.com/dsih-artpark/dataio.git

OR clone from source and install:

git clone https://github.com/dsih-artpark/dataio.git
cd dataio
uv sync

Installing from source will give you the latest version of the code, which may not be stable. It’s recommended that for specificity, you specify the version you want to install.

Configuration

The client relies on two variables to authenticate with the API Server:

  1. DATAIO_API_BASE_URL: The base URL of the API. Generally, this is https://dataio.artpark.ai/api/v1/

  2. DATAIO_API_KEY: The API key for the API.

You can set these variables in a .env file or pass them as arguments to the DataIOAPI constructor.

You can also run

uv run dataio init
# OR using venv
source .venv/bin/activate
dataio init

This will prompt you to enter your API key and set the default base URL and create an .env file in your project root:

DATAIO_API_BASE_URL=https://dataio.artpark.ai/api/v1
DATAIO_API_KEY=your_api_key_here
DATAIO_DATA_DIR=data

You can also di this manually.

Verifying Installation

Testing SDK Installation

from dataio import DataIOAPI

# Create client
client = DataIOAPI()
print("DataIO SDK installed successfully!")

Testing CLI Installation

You can run CLI commands in two ways:

Option 1: Using uv run (recommended)

uv run dataio --help

Option 2: Activate virtual environment

# Activate your virtual environment first
source .venv/bin/activate  # or your venv activation command
dataio --help

Getting API Access

Tip

Contact the DataIO administrators to get your API key if you haven’t already.

What’s Next?

Now that you have DataIO installed and configured, you can continue with Quick Start for your first API calls through the SDK, or use the CLI Guide for command-line operations