Metadata-Version: 2.1
Name: crosswork-companion
Version: 0.1.1
Summary: Business ready documents from Cisco Crosswork
Author: John Capobianco
Author-email: ptcapo@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: aiofiles (>=22.1.0,<23.0.0)
Requires-Dist: aiohttp (>=3.8.3,<4.0.0)
Requires-Dist: jinja2 (>=3.1.2,<4.0.0)
Requires-Dist: pyyaml (>=6.0,<7.0)
Requires-Dist: requests (>=2.28.2,<3.0.0)
Requires-Dist: rich-click (>=1.6.1,<2.0.0)
Description-Content-Type: text/markdown

# Crosswork Companion

Business Ready Documents for Cisco Crosswork

## Current API Coverage

Health Insights KPI Management Query

    pulse_cpu_utilization

    pulse_cpu_threshold

    pulse_cef_drops

    pulse_device_uptime

    pulse_ethernet_port_error_counters

    pulse_ethernet_port_packet_size_distribution

    pulse_interface_packet_counters

    pulse_interface_qos_egress

    pulse_interface_qos_ingress

    pulse_interface_rate_counters

    pulse_memory_utilization

NCA YANG Modules


## Installation

```console
$ python3 -m venv crosswork
$ source crosswork/bin/activate
(crosswork) $ pip install crosswork_companion
```

## Usage - Help

```console
(crosswork) $ crosswork_companion --help
```

![Help](/images/help.png)

## Usage - In-line

```console
(crossswork) $ crosswork_companion --url <url to Crosswork> --username <crosswork username> --password <crosswork password>
```

## Usage - Interactive

```console
(crosswork) $ crosswork_companion
Crosswork URL: <URL to Crosswork>
Crosswork Username: <Crosswork Username>
Crosswork Password: <Crosswork Password>
```

## Usage - Environment Variables

```console
(crosswork) $ export URL=<URL to Crosswork>
(crosswork) $ export USERNAME=<Crosswork Username>
(crosswork) $ export PASSWORD=<Crosswork Password>
```

## Recommended VS Code Extensions

Excel Viewer - CSV Files

Markdown Preview - Markdown Files

Markmap - Mindmap Files

Open in Default Browser - HTML Files

## Contact

Please contact John Capobianco if you need any assistance

