Installation

Requirements

• Python 3.10 or later
• An NVEIL API key

Install from PyPI

pip install nveil

This installs the SDK and all required dependencies including the data pipeline and visualization engine.

Verify the installation

import nveil
print("nveil installed successfully")

API Key

You need an API key to generate visualization specs.

1. Create an account at app.nveil.com
2. Go to Settings in your account
3. Generate an API key (starts with nveil_)

Configure it in your code:

nveil.configure(api_key="nveil_...")

Or set it as an environment variable:

export NVEIL_API_KEY="nveil_..."

Tip

Store your API key in a .env file or secret manager — never commit it to source control.

What's installed

The nveil package bundles two internal libraries:

• choregraph — data pipeline engine (transforms, metadata extraction)
• dive — visualization engine (spec models, multi-backend rendering)

You don't need to interact with these directly — the SDK wraps them into a simple API.