ep-tutorials

Getting Started with ndp-ep

This guide provides a quick introduction to the ndp-ep Python library for interacting with the NDP-EP API.

Installation

pip install ndp-ep

Quick Start

Initialize the Client

from ndp_ep import Client

# Using token authentication
client = Client(
    base_url="https://your-api-endpoint.com",
    token="your-api-token"
)

# Or using username/password
client = Client(
    base_url="https://your-api-endpoint.com",
    username="your-username",
    password="your-password"
)

Basic Operations

# List organizations
organizations = client.list_organizations()

# Search datasets
datasets = client.search_datasets(terms=["climate"])

# Get system status
status = client.get_system_status()

Key Features

The library provides methods for:

• Authentication: Token-based and username/password authentication
• Organizations: Create, list, and manage organizations
• Datasets: Search, register, update, and delete datasets
• Resources: Register URL, S3, and Kafka topic resources
• S3 Operations: Bucket management, file upload/download, presigned URLs
• Services: Register and manage microservices
• System Info: Check status, get Kafka details, Jupyter configuration

Next Steps

After getting familiar with the basics:

1. Learn about S3 integration
2. Check out the complete examples in this repository

Related Resources

• ndp-ep-py GitHub Repository