Skip to main content
Before you write your first agent, you need to install the nelieo-nsp package, point it at a running NSP daemon, and confirm the connection works. This page walks you through every step.

Requirements

Verify your Python version before installing:

Install the Package

Use a virtual environment to keep your project’s dependencies isolated. Create one with python -m venv .venv and activate it with source .venv/bin/activate (macOS/Linux) or .venv\Scripts\activate (Windows) before running pip install.

Dependencies

All dependencies are installed automatically. You do not need to install any of these separately:

Verify the Installation

After installing, confirm the package is importable and check the version:

Configure Environment Variables

The SDK reads three environment variables. Set them in your shell or in a .env file:
To generate an API key, run the following command on the machine where the daemon is installed:

Quick Connection Test

Run this script to verify that the daemon is reachable and confirm which apps are currently tracked:
Expected output when the daemon is running and has detected apps:

Troubleshooting

The daemon is not running or is not listening on the configured host and port. Start it with:
If you changed the default port, make sure NSP_PORT matches AXON_SERVER__PORT in your daemon configuration.
Your API key is missing, expired, or incorrect. Generate a fresh key:
Then set NSP_API_KEY in your environment or pass api_key="sk_nsp_..." directly to NSPClient.
The app you requested is not tracked yet. Use await client.list_apps() to see what the daemon currently sees. If you are targeting a Chrome tab, make sure Chrome was launched with --remote-debugging-port=9222.
You are likely running the wrong Python interpreter. Confirm you are using Python 3.11+ and that nelieo-nsp was installed into the active environment: