Skip to main content

​
Requirements

  • Python 3.10 or higher
  • pip or poetry for package management
  • Access to a Nadoo workspace (for deployment)

​
Install SDK

​
Using pip

pip install nadoo-plugin

​
Using poetry

poetry add nadoo-plugin

​
From source

git clone https://github.com/nadoo-ai/nadoo-plugin-sdk
cd nadoo-plugin-sdk
pip install -e .

​
Verify Installation

nadoo-plugin --version
You should see output like: 
Nadoo Plugin SDK v0.1.0

​
CLI Commands

The SDK includes a CLI for plugin development: 
nadoo-plugin --help
Available commands:
CommandDescription
createCreate a new plugin from template
buildBuild plugin package
installInstall plugin to Nadoo workspace
testRun plugin tests
validateValidate plugin structure

​
Development Environment Setup

​
1. Create Virtual Environment

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

​
2. Install SDK

pip install nadoo-plugin

​
3. Verify CLI

nadoo-plugin --version

​
IDE Setup

​
VS Code

Install Python extension and add to settings.json: 
{
  "python.linting.enabled": true,
  "python.linting.pylintEnabled": true,
  "python.formatting.provider": "black",
  "python.analysis.typeCheckingMode": "basic"
}

​
PyCharm

  1. Open Settings → Project → Python Interpreter
  2. Add nadoo-plugin package
  3. Enable type checking in inspections

​
Optional Dependencies

​
For LLM Integration Testing

pip install openai anthropic

​
For Testing Utilities

pip install pytest pytest-asyncio pytest-mock

​
For Development

pip install black pylint mypy

​
Environment Variables

For local development, create .env file: 
# Nadoo API credentials (for testing with real APIs)
NADOO_API_URL=https://api.nadoo.ai
NADOO_API_TOKEN=your_token_here
NADOO_WORKSPACE_ID=your_workspace_id

# Plugin-specific env vars
MY_API_KEY=secret_key

​
Next Steps

Quick Start

Build your first plugin

Plugin Class

Learn the basics