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.1.tar.gz (15.4 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.1-py3-none-any.whl (14.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: netpulse_sdk-0.1.1.tar.gz
  • Upload date:
  • Size: 15.4 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.1.tar.gz
Algorithm Hash digest
SHA256 d201259de0728115533623877611df851bd68a2b4d02ed68ca777f56d3d3bd14
MD5 55837256cd2026fac528f698450f89d0
BLAKE2b-256 5b5a07a0ab1383f25341ef9d26780e62f8458fabafbb24bb982caa4100d8cdfa

See more details on using hashes here.

File details

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

File metadata

  • Download URL: netpulse_sdk-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 14.7 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 758b14b278819c8fb1f16b4ee61d3c4e3cf696ac21ccf0d7660e7c817b8c7058
MD5 5c9f885fa8e319d9e101d0f28d1929a2
BLAKE2b-256 c911f7fe29f73d16e4e41fbb7f309caffe639ede83182d29529b02c134d3e970

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