Metadata-Version: 2.4
Name: netbox-pdm
Version: 0.0.1
Summary: NetBox plugin for Proxmox Datacenter Manager (PDM) inventory through proxbox-api
Author-email: Emerson Felipe <emersonfelipe.2003@gmail.com>
License-Expression: Apache-2.0
Project-URL: Homepage, https://github.com/emersonfelipesp/netbox-pdm
Project-URL: Documentation, https://emersonfelipesp.github.io/netbox-pdm/
Project-URL: Source, https://github.com/emersonfelipesp/netbox-pdm
Project-URL: Issues, https://github.com/emersonfelipesp/netbox-pdm/issues
Requires-Python: >=3.12
Description-Content-Type: text/markdown
Requires-Dist: netbox-proxbox>=0.0.16
Requires-Dist: requests>=2.33.0
Provides-Extra: test
Requires-Dist: pytest>=9.0.3; extra == "test"
Requires-Dist: pytest-cov>=7.1.0; extra == "test"
Provides-Extra: docs
Requires-Dist: mkdocs>=1.6; extra == "docs"
Requires-Dist: mkdocs-material>=9.5; extra == "docs"
Requires-Dist: mkdocstrings[python]>=0.27; extra == "docs"
Requires-Dist: ghp-import>=2.1; extra == "docs"

# netbox-pdm

NetBox plugin that reflects **Proxmox Datacenter Manager (PDM)** inventory —
remotes, views, and SDN-adjacent state — into NetBox through the
[`proxbox-api`](https://github.com/emersonfelipesp/proxbox-api) backend.

`netbox-pdm` is a sibling plugin of
[`netbox-proxbox`](https://github.com/emersonfelipesp/netbox-proxbox); it
reuses `netbox-proxbox` FastAPI endpoint resolution and job conventions when
that plugin is installed, and falls back to its own `proxbox_api_url` /
`proxbox_api_key` plugin settings otherwise.

## Status

`netbox-pdm` v0.0.1 ships the plugin scaffold and NetBox installation glue.
Model and sync views land in upcoming releases. The plugin is **read-only**:
all mutations remain in PDM.

## Requirements

- NetBox 4.5.x – 4.6.x
- Python 3.12+
- [`netbox-proxbox`](https://github.com/emersonfelipesp/netbox-proxbox) `>= 0.0.16`
- A reachable [`proxbox-api`](https://github.com/emersonfelipesp/proxbox-api)
  instance with PDM-aware endpoints enabled

## Installation

```bash
pip install netbox-pdm
```

In `configuration.py`:

```python
PLUGINS = [
    "netbox_proxbox",
    "netbox_pdm",
]
```

```bash
python manage.py migrate
```

## Documentation

Full documentation is published at
<https://emersonfelipesp.github.io/netbox-pdm/>.

## License

Apache-2.0
