Skip to main content

Python SDK for NetPulse Network Automation Platform

Project description

NetPulse SDK

Python SDK for NetPulse Network Automation Platform.

Installation

pip install netpulse-sdk

Quick Start

from netpulse_sdk import NetPulseClient

# Initialize client
client = NetPulseClient(
    base_url="http://localhost:9000",
    api_key="your-api-key",
    default_connection_args={
        "device_type": "cisco_ios",
        "username": "admin",
        "password": "admin",
    },
)

# Collect device information
job = client.collect(
    devices=["10.1.1.1", "10.1.1.2"],
    commands=["show version"],
)

# Process results
for result in job:
    if result.ok:
        # print line in 50
        print(f"{result.device_name}: {result.stdout[:50]}...")
    else:
        print(f"{result.device_name}: {result.error.message}")

Features

  • Batch Execution: Execute commands on multiple devices simultaneously
  • Configuration Push: Push configuration changes to network devices
  • Stream Processing: Process results as they complete
  • Progress Monitoring: Track job progress in real-time
  • Error Handling: Comprehensive error handling with detailed error messages
  • Multiple Drivers: Support for netmiko, napalm, pyeapi, and paramiko

Supported Drivers

  • netmiko (default) - Most network devices (Cisco, HP, Huawei, Juniper, etc.)
  • napalm - Multi-vendor unified interface
  • pyeapi - Arista devices (eAPI)
  • paramiko - Linux servers

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

netpulse_sdk-0.1.0.tar.gz (15.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

netpulse_sdk-0.1.0-py3-none-any.whl (14.4 kB view details)

Uploaded Python 3

File details

Details for the file netpulse_sdk-0.1.0.tar.gz.

File metadata

  • Download URL: netpulse_sdk-0.1.0.tar.gz
  • Upload date:
  • Size: 15.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.11

File hashes

Hashes for netpulse_sdk-0.1.0.tar.gz
Algorithm Hash digest
SHA256 30d43bbb4f8c13b6f5f9b13d192ce1e4ea594ba64ad9ac1499b755f541a97f88
MD5 b67fab8db78012fde77f961632f3fcac
BLAKE2b-256 f9902cb83993d73f07262eb3241333f3026abb32f35edff83b9eb3b13ebc0921

See more details on using hashes here.

File details

Details for the file netpulse_sdk-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: netpulse_sdk-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 14.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.11

File hashes

Hashes for netpulse_sdk-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 99ef983679a54469db983424b2cebd20c6eca254ae4e6bd8082f594a3acc3afd
MD5 e7c931d857edfd4ab3720abbc0b59479
BLAKE2b-256 3e745977d35d7fe5e196aa9a21ef5c0320e5f33289f6d3d62a23f771cccaec67

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page