Developer Guide¶
Technical documentation for contributors and anyone building on top of netbox-sdk.
- Architecture — module map, three-package dependency direction, data flow, and packaging
- SDK Internals — how the client, config, schema, facade, cache, and services modules work internally
- Integration with proxbox-api — session factory, REST helpers, concurrency, caching, retry, and real-world integration patterns
- Package integration — PyPI extras,
netbox_sdk/netbox_cli/netbox_tui, import rules - Design principles — SOLID-aligned conventions for this repo
- Textual Composition Pattern — React-style composition guideline for Textual widgets
- Documentation Generation — the command capture system and CI workflow
- IDE Support — VS Code workspace, Pylance via PEP 561 markers, and the dual
ty+pyrightchecker gates