Commit Graph

17 Commits

Author SHA1 Message Date
darnodo
97cdc161da docs(gnmi): remove async context manager references from client
Remove outdated async documentation from GNMIClient module:
- Remove async context manager from feature list
- Remove async usage example from class docstring

The client now only documents synchronous usage patterns.
2025-12-31 17:48:29 +01:00
darnodo
5b3517c355 fix: resolve import paths, remove async context managers, clean up CLI
- Change absolute imports to relative imports in gnmi module
- Remove async context manager methods (pygnmi is synchronous)
- Remove unimplemented --depth option from CLI
- Update documentation to reflect sync-only usage
2025-12-31 17:44:21 +01:00
darnodo
8e460225c2 docs: format markdown tables in yang-paths.md
Improve table readability by aligning columns with consistent
spacing and proper markdown table formatting throughout the
YANG paths reference documentation.
2025-12-31 17:18:01 +01:00
darnodo
e355cce4c8 docs: add CLI user guide for fabric-orch commands
Add comprehensive documentation for the fabric-orch CLI tool covering:
- Installation and quick start instructions
- Environment variables for gNMI authentication
- All discover subcommands (capabilities, get, set, subscribe, paths)
- YANG path syntax reference and common paths table
- Output formats and error handling guidance
2025-12-31 17:15:56 +01:00
darnodo
e041dab724 feat(build): configure project tooling and update dependencies
- Replace placeholder deps with click, pygnmi, and rich for CLI functionality
- Add fabric-orch CLI entry point via project.scripts
- Configure hatchling as build backend with wheel/sdist targets
- Add ruff linter configuration for code quality
- Add dev dependency group with ruff
- Alphabetize yang module imports
2025-12-31 09:36:00 +01:00
darnodo
3e76eba46a refactor(yang): remove unused Optional import from paths
The `Optional` type was imported from `typing` in `src/yang/paths.py`
but was not being used in the file. This change removes the unnecessary
import to clean up the code.
2025-12-26 15:59:25 +01:00
darnodo
f8ef64e9b0 docs: update installation steps and reformat markdown tables
- Update the dependency installation command in the main README to use `uv sync` instead of `pip`, reflecting the project's package manager.
- Realign markdown tables in `src/yang/README.md` to improve raw text readability and consistency.
2025-12-26 15:56:17 +01:00
ad3e93b933 Actualiser README.md 2025-12-26 14:48:56 +00:00
a796864aad Actualiser README.md 2025-12-26 14:46:19 +00:00
b864273dfb Actualiser README.md 2025-12-26 14:45:10 +00:00
0f0336296a docs: add README for yang module
Usage examples for all path classes:
- Interfaces, Loopbacks, VLANs
- BGP with AFI-SAFI
- VXLAN VNI mappings
- MLAG, EVPN (with limitations noted)
- Port-Channel
- Subscription helpers

Part of #3
2025-12-26 13:47:00 +00:00
9edf963704 feat: add yang package init
Exports all YANG path classes for easy imports.

Part of #3
2025-12-26 13:42:47 +00:00
f335d1fc33 feat: add YANG path constants module
Python module with validated gNMI YANG paths for:
- Interfaces, Loopbacks, VLANs (OpenConfig)
- BGP with neighbor and AFI-SAFI helpers (OpenConfig)
- VXLAN VNI mappings (Arista experimental)
- MLAG and EVPN config (Arista experimental)
- Port-Channel/LAG paths
- Subscription helpers for fabric monitoring

Part of #3
2025-12-26 13:42:31 +00:00
4c7634da59 docs: add YANG paths reference documentation
Comprehensive documentation of validated gNMI YANG paths for:
- Interfaces, Loopbacks, VLANs (OpenConfig)
- BGP with EVPN AFI (OpenConfig)
- VXLAN VNI mappings (Arista experimental)
- MLAG and EVPN config (Arista experimental)

Includes examples, limitations, and key learnings.

Closes partial requirement for #3
2025-12-26 13:39:58 +00:00
8a069c1e24 docs: Simplify README, link to issues for phase tracking 2025-12-20 15:50:16 +00:00
9102bc1318 docs: Add comprehensive README with architecture and project phases 2025-12-20 15:36:14 +00:00
cac41f330d Initial commit 2025-12-20 15:34:01 +00:00