topolograph-sdk 0.1.0__tar.gz

topolograph_sdk-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

topolograph_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,366 @@
+Metadata-Version: 2.4
+Name: topolograph-sdk
+Version: 0.1.0
+Summary: Python SDK for Topolograph - A Pythonic client for the Topolograph REST API with SSH-based topology ingestion
+Author-email: Topolograph <info@topolograph.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/topolograph/topolograph-sdk
+Project-URL: Documentation, https://github.com/topolograph/topolograph-sdk
+Project-URL: Repository, https://github.com/topolograph/topolograph-sdk
+Project-URL: Issues, https://github.com/topolograph/topolograph-sdk/issues
+Keywords: topolograph,network,topology,ospf,isis,lsdb
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: System :: Networking
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.28.0
+Requires-Dist: nornir>=3.0.0
+Requires-Dist: nornir-scrapli>=2022.1.0
+Requires-Dist: typer>=0.9.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: rich>=13.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.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
+
+# Topolograph Python SDK
+
+A Pythonic, object-oriented client for the Topolograph REST API with built-in topology ingestion via SSH.
+
+## Features
+
+- **Pythonic API Client**: Clean, object-oriented interface to the Topolograph REST API
+- **SSH-Based Collection**: Collect IGP LSDB data directly from network devices using Nornir
+- **CLI Interface**: Command-line tool built on top of the SDK
+- **PyPI Ready**: Installable via `pip install topolograph-sdk`
+
+## Installation
+
+```bash
+pip install topolograph-sdk
+```
+
+## Quick Start
+
+### Basic Usage
+
+```python
+from topolograph import Topolograph
+
+# Initialize client
+topo = Topolograph(
+    url="http://localhost:8080",
+    token="your-api-token"  # or set TOPOLOGRAPH_TOKEN env var
+)
+
+# Get latest graph
+graph = topo.graphs.get(latest=True)
+
+# Access graph properties
+print(f"Graph Time: {graph.graph_time}")
+print(f"Protocol: {graph.protocol}")
+print(f"Hosts: {graph.hosts['count']}")
+
+# Get graph status
+status = graph.status()
+print(f"Status: {status['status']}")
+```
+
+### Collecting Topology Data
+
+```python
+from topolograph import TopologyCollector
+
+# Create collector with inventory file
+collector = TopologyCollector("inventory.yaml")
+
+# Collect LSDB data
+result = collector.collect()
+
+# Access results
+print(f"Collected from {len(result.host_results)} hosts")
+print(f"LSDB text length: {len(result.raw_lsdb_text)}")
+
+# Upload to Topolograph
+graph = topo.uploader.upload_raw(
+    lsdb_text=result.raw_lsdb_text,
+    vendor="FRR",
+    protocol="isis"
+)
+```
+
+### Inventory Format
+
+Create a YAML inventory file with explicit vendor and protocol metadata. A sample inventory file (`inventory.yaml.example`) is provided in the project root:
+
+```yaml
+---
+router1:
+  hostname: 172.20.20.2
+  username: admin
+  password: admin
+  vendor: frr
+  protocol: isis
+  port: 22
+
+router2:
+  hostname: 172.20.20.3
+  username: admin
+  password: admin
+  vendor: cisco
+  protocol: ospf
+  port: 22
+```
+
+**Required fields:**
+- `hostname`: IP address or hostname of the device
+- `username`: SSH username
+- `password`: SSH password
+- `vendor`: Device vendor (`cisco`, `juniper`, `frr`, `arista`, `nokia`, `huawei`)
+- `protocol`: IGP protocol (`ospf`, `isis`)
+- `port`: SSH port (optional, defaults to 22)
+
+**Quick start:** Copy the example inventory file:
+```bash
+cp inventory.yaml.example inventory.yaml
+# Edit inventory.yaml with your device credentials
+```
+
+### Working with Graphs
+
+```python
+# List all graphs
+graphs = topo.graphs.list(protocol="ospf")
+
+# Get specific graph
+graph = topo.graphs.get_by_time("2024-01-15T10:30:00Z")
+
+# Get nodes
+nodes = graph.nodes.get()
+for node in nodes:
+    print(f"Node: {node.name} (ID: {node.id})")
+
+# Find networks
+networks = graph.networks.find_by_ip("10.10.10.1")
+networks = graph.networks.find_by_node("1.1.1.1")
+network = graph.networks.find_by_network("10.10.10.0/24")
+```
+
+### Path Computation
+
+```python
+# Shortest path between nodes
+path = graph.paths.shortest("1.1.1.1", "2.2.2.2")
+print(f"Path cost: {path.cost}")
+for path_nodes in path.paths:
+    print(f"Path: {' -> '.join(path_nodes)}")
+
+# Shortest path between networks/IPs
+path = graph.paths.shortest_network("192.168.1.1", "192.168.2.1")
+
+# Backup path (removing specific edges)
+path = graph.paths.shortest(
+    "1.1.1.1",
+    "2.2.2.2",
+    removed_edges=[("1.1.1.1", "3.3.3.3")]
+)
+```
+
+### Events
+
+```python
+# Get network events
+network_events = graph.events.get_network_events(last_minutes=60)
+for event in network_events['network_up_down_events']:
+    print(f"Network {event.event_object} is {event.event_status}")
+
+# Get adjacency events
+adjacency_events = graph.events.get_adjacency_events(
+    start_time="2024-01-15T10:00:00Z",
+    end_time="2024-01-15T11:00:00Z"
+)
+```
+
+## CLI Usage
+
+The SDK includes a CLI tool accessible via the `topo` command:
+
+### List Graphs
+
+```bash
+# List all graphs
+topo graphs --list
+
+# Get latest graph
+topo graphs --latest
+
+# Filter by protocol
+topo graphs --list --protocol ospf
+
+# Filter by watcher
+topo graphs --list --watcher production-watcher
+```
+
+### Collect and Upload Topology
+
+```bash
+# Collect LSDB from devices
+topo ingest inventory.yaml --protocol isis
+
+# Collect and save to file
+topo ingest inventory.yaml --output lsdb.txt
+
+# Collect and upload to Topolograph
+topo ingest inventory.yaml --upload --url http://localhost:8080
+```
+
+### Compute Paths
+
+```bash
+# Shortest path between nodes
+topo path --src 1.1.1.1 --dst 2.2.2.2
+
+# Shortest path between networks
+topo path --src 192.168.1.1 --dst 192.168.2.1 --network
+
+# Use specific graph
+topo path --src 1.1.1.1 --dst 2.2.2.2 --graph-time "2024-01-15T10:30:00Z"
+```
+
+### Upload LSDB Files
+
+```bash
+# Upload a LSDB file
+topo upload --file lsdb.txt --vendor FRR --protocol isis
+
+# Upload with watcher name
+topo upload --file lsdb.txt --vendor Cisco --protocol ospf --watcher prod-watcher
+```
+
+## Supported Vendors and Protocols
+
+### OSPF
+- **Cisco**: `show ip ospf database router`, `show ip ospf database network`, `show ip ospf database external`
+- **Juniper**: `show ospf database router extensive | no-more`, etc.
+- **FRR/Quagga**: `show ip ospf database router`, etc.
+- **Arista**: `show ip ospf database router detail`, etc.
+- **Nokia**: `show router ospf database router detail`, etc.
+
+### IS-IS
+- **Cisco**: `show isis database detail`
+- **Juniper**: `show isis database extensive`
+- **FRR**: `show isis database detail`
+- **Nokia**: `show router isis database detail`
+- **Huawei**: `display isis lsdb verbose`
+
+## Authentication
+
+The SDK supports multiple authentication methods (in priority order):
+
+1. **Explicit token parameter**:
+   ```python
+   topo = Topolograph(url="...", token="your-token")
+   ```
+
+2. **Environment variable**:
+   ```bash
+   export TOPOLOGRAPH_TOKEN="your-token"
+   ```
+
+3. **Basic authentication**:
+   ```python
+   topo = Topolograph(url="...", username="user", password="pass")
+   ```
+
+## Error Handling
+
+The SDK raises custom exceptions for different error scenarios:
+
+```python
+from topolograph.exceptions import (
+    AuthenticationError,
+    NotFoundError,
+    ValidationError,
+    APIError
+)
+
+try:
+    graph = topo.graphs.get_by_time("invalid-time")
+except NotFoundError:
+    print("Graph not found")
+except AuthenticationError:
+    print("Authentication failed")
+except APIError as e:
+    print(f"API error: {e}")
+```
+
+## Testing
+
+Run integration tests with containerlab:
+
+```bash
+# Set environment variables
+export TOPOLOGRAPH_URL="http://localhost:8080"
+export TOPOLOGRAPH_TOKEN="your-token"
+
+# Run tests
+pytest tests/test_integration.py -v
+```
+
+Or use the manual test script:
+
+```bash
+python test_sdk.py
+```
+
+## Development
+
+### Setup Development Environment
+
+```bash
+# Clone repository
+git clone https://github.com/topolograph/topolograph-sdk.git
+cd topolograph-sdk
+
+# Install in development mode
+pip install -e ".[dev]"
+```
+
+### Project Structure
+
+```
+topolograph-sdk/
+├── topolograph/          # SDK package
+│   ├── client.py        # Core HTTP client
+│   ├── resources/       # Resource objects (Graph, Node, Network, etc.)
+│   ├── collector/       # SSH-based topology collection
+│   └── upload/          # Upload pipeline
+├── cli/                 # CLI interface
+├── tests/               # Test suite
+└── pyproject.toml       # Package configuration
+```
+
+## License
+
+Apache License 2.0 - See LICENSE file for details.
+
+## Contributing
+
+Contributions are welcome! Please open an issue or submit a pull request.
+
+## Support
+
+For issues, questions, or feature requests, please open an issue on GitHub.