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.2.0.tar.gz (20.8 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.2.0-py3-none-any.whl (20.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: netpulse_sdk-0.2.0.tar.gz
  • Upload date:
  • Size: 20.8 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.2.0.tar.gz
Algorithm Hash digest
SHA256 bb8e11c0d5935bce1642e067dc9f6110205a64f178af484af81ab0dd0d735a8e
MD5 450e6c2b7fd52181a2231327395c344a
BLAKE2b-256 6fbcfaf1a47bb28ce465f84db17fa8e60b1462ced813aa4a4390775e5e62788f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: netpulse_sdk-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 20.9 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.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 af3723626218cbb5dd50a4671cd61de12741d0019f38e62ecaac56b4921b5377
MD5 e07d732ab59c4c0c1fbef897fa72e36a
BLAKE2b-256 5d88f1ced2f1d961fabc21df75a788fd9459d49bcad773dffaee5254399d8a49

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