Metadata-Version: 2.4
Name: netpulse-sdk
Version: 0.2.0
Summary: Python SDK for NetPulse Network Automation Platform
Author-email: NetPulse Team <44155313+Nativu5@users.noreply.github.com>
Maintainer-email: NetPulse Team <44155313+Nativu5@users.noreply.github.com>
License: MIT
Project-URL: Homepage, https://github.com/scitix/netpulse
Project-URL: Documentation, https://netpulse.readthedocs.io
Project-URL: Repository, https://github.com/scitix/netpulse
Project-URL: SDK Documentation, https://github.com/scitix/netpulse/tree/main/sdk
Keywords: network,automation,netpulse,sdk,api-client
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: System :: Networking
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests>=2.31.0
Requires-Dist: pydantic>=2.0.0
Requires-Dist: PyYAML>=6.0.0
Provides-Extra: dev
Requires-Dist: pytest>=7.0.0; extra == "dev"
Requires-Dist: pytest-mock>=3.10.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
Requires-Dist: black>=23.0.0; extra == "dev"
Requires-Dist: ruff>=0.1.0; extra == "dev"
Dynamic: license-file

# NetPulse SDK

Python SDK for NetPulse Network Automation Platform.

## Installation

```bash
pip install netpulse-sdk
```

## Quick Start

```python
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
