netbox-sdk v0.0.5

netbox-sdk v0.0.5

v0.0.5 is the first release where the standalone SDK work that lived on v6 is published from main. Compared with v0.0.4, this release turns the repository into a real netbox-sdk package with a dedicated API client surface, versioned typed models, a PyNetBox-style facade, expanded documentation, and CI/doc publishing updates to support the split.

Highlights

Standalone SDK extraction

• Extracts the SDK into the dedicated netbox_sdk package and reorganizes the repo around an SDK-first layout instead of keeping the code embedded inside the older CLI package structure.
• Splits package and test suite boundaries so the SDK, TUI, and legacy CLI concerns are easier to maintain independently.
• Publishes the release from the main branch after bringing forward the full v6 branch history that introduced the SDK split.

Async client and facade improvements

• Adds a standalone async NetBoxApiClient implementation under netbox_sdk.client.
• Introduces a PyNetBox-style parity facade in netbox_sdk.facade, including higher-level API/App/Endpoint abstractions for more ergonomic resource access.
• Keeps compatibility-focused behavior in supporting modules such as config loading, schema helpers, demo auth refresh, request resolution, cache handling, and plugin discovery while moving those capabilities under SDK-owned namespaces.

Bundled typed SDK support

• Adds generated typed models for NetBox 4.3, 4.4, and 4.5.
• Adds typed version dispatch/runtime support so callers can select a supported NetBox version explicitly.
• Bundles OpenAPI reference documents used to generate and validate the typed SDK surface.
• Expands SDK completeness, import, parity, and typed-version tests to cover the generated client stack.

Documentation and developer guidance

• Adds dedicated SDK docs for authentication, request execution, facade usage, schema handling, typed usage, and error handling.
• Refreshes repository branding and docs so installation and quickstart flows align with netbox-sdk rather than the earlier CLI-centric framing.
• Adds PyNetBox reference material and more command examples for local development and schema exploration.

CI, quality, and maintenance

• Updates docs publishing and release-related workflows to align with the SDK split.
• Incorporates multiple rounds of Ruff, pre-commit, and Copilot review fixes after the large package move.
• Improves return typing coverage and generated code quality across the repository.

Upgrade Notes

• The primary package surface is now netbox_sdk, not netbox_cli.
• If you were importing internal modules from the previous CLI-oriented layout, expect import path changes due to the SDK/TUI package split.
• This release is best treated as a structural upgrade focused on packaging, API ergonomics, and typed SDK support rather than a small patch-only drop.

Commit Summary Since v0.0.4

• ce31958 feat: extract standalone sdk package from netbox_cli
• 7c0b23b reorganize packages and split package test suites
• 42f18cd add PyNetBox reference and refresh docs
• f34edd6 add async PyNetBox-style parity facade to netbox_sdk
• 04f3f9c add bundled versioned typed NetBox SDK
• c17a18f document facade and typed SDK usage
• 67cf236 complete repo-wide return typing and typed client generation
• 7c145c7 align docs branding and guidance with netbox-sdk
• 3a0015e keep docs publishing aligned with netbox-sdk
• 3b6ba59 fix generated typed SDK lint for CI
• 346efc0 apply actionable Copilot review fixes
• b253976 apply remaining Ruff fixes from CI
• a008e07 fix final pre-commit issues on CLI and TUI modules
• 7d1bd9e apply latest Copilot review fixes
• cab14e1 release: bump version to v0.0.5

Full Compare

• Compare changes: v0.0.4...v0.0.5