netbox-sdk 0.0.3__tar.gz

netbox_sdk-0.0.3/LICENSE.txt

@@ -0,0 +1,177 @@
+
+                                 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

netbox_sdk-0.0.3/PKG-INFO

@@ -0,0 +1,230 @@
+Metadata-Version: 2.4
+Name: netbox-sdk
+Version: 0.0.3
+Summary: API-first NetBox CLI + Textual TUI
+Author-email: Emerson Felipe <emerson@netdevopsbr.com>
+Maintainer-email: Emerson Felipe <emerson@netdevopsbr.com>
+Project-URL: Homepage, https://github.com/emersonfelipesp/netbox-cli
+Project-URL: Documentation, https://emersonfelipesp.com/netbox-cli
+Project-URL: Repository, https://github.com/emersonfelipesp/netbox-cli
+Project-URL: Issues, https://github.com/emersonfelipesp/netbox-cli/issues
+Project-URL: Changelog, https://github.com/emersonfelipesp/netbox-cli/releases
+Keywords: netbox,terminal,netbox-integration,tui,cli,terminal,api,integration
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet
+Classifier: Topic :: System :: Networking
+Classifier: Topic :: System :: Systems Administration
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: aiohttp>=3.9.0
+Requires-Dist: playwright>=1.52.0
+Requires-Dist: pydantic>=2.0
+Requires-Dist: typer>=0.12.0
+Requires-Dist: rich>=13.7.0
+Requires-Dist: textual>=0.62.0
+Requires-Dist: pyyaml>=6.0.0
+Provides-Extra: dev
+Requires-Dist: pre-commit>=4.0.0; extra == "dev"
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23.0; extra == "dev"
+Requires-Dist: pytest-timeout>=2.3.0; extra == "dev"
+Requires-Dist: pytest-xdist>=3.5.0; extra == "dev"
+Requires-Dist: ruff>=0.11.0; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mkdocs-material>=9.5; extra == "docs"
+Dynamic: license-file
+
+# NetBox CLI and TUI
+
+`netbox-cli` is a terminal client for NetBox with two ways to work:
+
+- fast command-line operations such as `nbx dcim devices get --id 1`
+- interactive terminal apps such as `nbx tui` and `nbx dev tui`
+
+> Temporary naming note: the GitHub repository remains `netbox-cli`, but the
+> published PyPI package is currently `netbox-console` due to PyPI naming policy
+> constraints tracked in https://github.com/pypi/support/issues/9925. This will
+> be reverted to `netbox-cli` on PyPI after that issue is resolved.
+
+## Quick Start with the Demo Instance
+
+Install (official PyPI):
+
+```bash
+sudo apt-get update && sudo apt-get install -y curl
+curl -fsSL https://raw.githubusercontent.com/emersonfelipesp/netbox-cli/main/install.sh | bash
+```
+
+Reload your shell:
+
+```bash
+source ~/.bashrc   # bash
+source ~/.zshrc    # zsh
+```
+
+Authenticate against the public demo instance:
+
+```bash
+nbx demo init
+```
+
+Try a few commands:
+
+```bash
+nbx demo dcim devices list
+nbx demo ipam prefixes list
+nbx demo tui
+nbx demo dev tui
+```
+
+## Install
+
+Install from official PyPI:
+
+```bash
+pip install netbox-console
+```
+
+or with `uv`:
+
+```bash
+uv tool install --force netbox-console
+```
+
+Install from a local checkout (developer workflow):
+
+```bash
+cd <path-to-netbox-cli>
+uv tool install --force .
+```
+
+If `nbx` is not available after install, make sure `~/.local/bin` is in your `PATH`.
+
+## Configure
+
+Set up your normal profile:
+
+```bash
+nbx init
+```
+
+Set up the demo profile:
+
+```bash
+nbx demo init
+```
+
+You can also pass credentials directly when needed:
+
+```bash
+nbx demo init --username <your-demo-user> --password <your-demo-password>
+```
+
+## Common Commands
+
+List and inspect resources:
+
+```bash
+nbx dcim devices list
+nbx dcim devices get --id 1
+nbx ipam prefixes list
+```
+
+Create or update objects:
+
+```bash
+nbx ipam ip-addresses create --body-json '{"address":"192.0.2.10/24","status":"active"}'
+nbx dcim devices patch --id 1 --body-json '{"name":"edge-sw01"}'
+```
+
+Send direct HTTP requests:
+
+```bash
+nbx call GET /api/status/
+nbx call POST /api/ipam/ip-addresses/ --body-file ./payload.json
+```
+
+Explore available groups, resources, and operations:
+
+```bash
+nbx groups
+nbx resources dcim
+nbx ops dcim devices
+```
+
+## TUI Modes
+
+Main TUI:
+
+```bash
+nbx tui
+nbx demo tui
+```
+
+Developer workbench:
+
+```bash
+nbx dev tui
+nbx demo dev tui
+```
+
+Log viewer:
+
+```bash
+nbx logs
+```
+
+## Themes
+
+List available themes:
+
+```bash
+nbx tui --theme
+```
+
+Start with a specific theme:
+
+```bash
+nbx tui --theme dracula
+nbx tui --theme netbox-light
+nbx dev tui --theme netbox-dark
+```
+
+You can also change themes live from the top-left theme selector in the TUI.
+
+## Useful TUI Keys
+
+- `/` focus search
+- `g` focus navigation
+- `s` focus results
+- `r` refresh current resource
+- `f` open filters
+- `d` switch to details
+- `q` quit
+
+## Custom Themes
+
+Built-in themes include:
+
+- `netbox-dark`
+- `dracula`
+- `netbox-light`
+
+You can add your own theme by placing a JSON theme file in `netbox_cli/themes/`.
+
+## Tips
+
+- `nbx demo ...` uses a separate demo profile from your normal `nbx ...` profile.
+- If a command works in the CLI, there is usually a matching flow in the TUI.
+- The Dev TUI is useful for exploring endpoints, request timing, and raw JSON responses.

netbox_sdk-0.0.3/README.md

@@ -0,0 +1,183 @@
+# NetBox CLI and TUI
+
+`netbox-cli` is a terminal client for NetBox with two ways to work:
+
+- fast command-line operations such as `nbx dcim devices get --id 1`
+- interactive terminal apps such as `nbx tui` and `nbx dev tui`
+
+> Temporary naming note: the GitHub repository remains `netbox-cli`, but the
+> published PyPI package is currently `netbox-console` due to PyPI naming policy
+> constraints tracked in https://github.com/pypi/support/issues/9925. This will
+> be reverted to `netbox-cli` on PyPI after that issue is resolved.
+
+## Quick Start with the Demo Instance
+
+Install (official PyPI):
+
+```bash
+sudo apt-get update && sudo apt-get install -y curl
+curl -fsSL https://raw.githubusercontent.com/emersonfelipesp/netbox-cli/main/install.sh | bash
+```
+
+Reload your shell:
+
+```bash
+source ~/.bashrc   # bash
+source ~/.zshrc    # zsh
+```
+
+Authenticate against the public demo instance:
+
+```bash
+nbx demo init
+```
+
+Try a few commands:
+
+```bash
+nbx demo dcim devices list
+nbx demo ipam prefixes list
+nbx demo tui
+nbx demo dev tui
+```
+
+## Install
+
+Install from official PyPI:
+
+```bash
+pip install netbox-console
+```
+
+or with `uv`:
+
+```bash
+uv tool install --force netbox-console
+```
+
+Install from a local checkout (developer workflow):
+
+```bash
+cd <path-to-netbox-cli>
+uv tool install --force .
+```
+
+If `nbx` is not available after install, make sure `~/.local/bin` is in your `PATH`.
+
+## Configure
+
+Set up your normal profile:
+
+```bash
+nbx init
+```
+
+Set up the demo profile:
+
+```bash
+nbx demo init
+```
+
+You can also pass credentials directly when needed:
+
+```bash
+nbx demo init --username <your-demo-user> --password <your-demo-password>
+```
+
+## Common Commands
+
+List and inspect resources:
+
+```bash
+nbx dcim devices list
+nbx dcim devices get --id 1
+nbx ipam prefixes list
+```
+
+Create or update objects:
+
+```bash
+nbx ipam ip-addresses create --body-json '{"address":"192.0.2.10/24","status":"active"}'
+nbx dcim devices patch --id 1 --body-json '{"name":"edge-sw01"}'
+```
+
+Send direct HTTP requests:
+
+```bash
+nbx call GET /api/status/
+nbx call POST /api/ipam/ip-addresses/ --body-file ./payload.json
+```
+
+Explore available groups, resources, and operations:
+
+```bash
+nbx groups
+nbx resources dcim
+nbx ops dcim devices
+```
+
+## TUI Modes
+
+Main TUI:
+
+```bash
+nbx tui
+nbx demo tui
+```
+
+Developer workbench:
+
+```bash
+nbx dev tui
+nbx demo dev tui
+```
+
+Log viewer:
+
+```bash
+nbx logs
+```
+
+## Themes
+
+List available themes:
+
+```bash
+nbx tui --theme
+```
+
+Start with a specific theme:
+
+```bash
+nbx tui --theme dracula
+nbx tui --theme netbox-light
+nbx dev tui --theme netbox-dark
+```
+
+You can also change themes live from the top-left theme selector in the TUI.
+
+## Useful TUI Keys
+
+- `/` focus search
+- `g` focus navigation
+- `s` focus results
+- `r` refresh current resource
+- `f` open filters
+- `d` switch to details
+- `q` quit
+
+## Custom Themes
+
+Built-in themes include:
+
+- `netbox-dark`
+- `dracula`
+- `netbox-light`
+
+You can add your own theme by placing a JSON theme file in `netbox_cli/themes/`.
+
+## Tips
+
+- `nbx demo ...` uses a separate demo profile from your normal `nbx ...` profile.
+- If a command works in the CLI, there is usually a matching flow in the TUI.
+- The Dev TUI is useful for exploring endpoints, request timing, and raw JSON responses.

netbox_sdk-0.0.3/netbox_cli/__init__.py

@@ -0,0 +1,4 @@
+"""netbox-cli package."""
+
+__all__ = ["__version__"]
+__version__ = "0.1.0"