unifi-network-maps 1.3.1__py3-none-any.whl → 1.4.1__py3-none-any.whl

{unifi_network_maps-1.3.1.dist-info → unifi_network_maps-1.4.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: unifi-network-maps
-Version: 1.3.1
+Version: 1.4.1
 Summary: Dynamic UniFi -> network maps in mermaid or svg
 Author: Merlijn
 License-Expression: MIT
@@ -14,22 +14,21 @@ Classifier: Intended Audience :: System Administrators
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Documentation
 Classifier: Topic :: System :: Networking
-Requires-Python: >=3.10
+Requires-Python: >=3.13
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: unifi-controller-api
-Requires-Dist: python-dotenv
-Requires-Dist: PyYAML
+Requires-Dist: unifi-controller-api==0.3.2
+Requires-Dist: python-dotenv==1.2.1
+Requires-Dist: PyYAML==6.0.3
 Provides-Extra: dev
-Requires-Dist: pre-commit; extra == "dev"
-Requires-Dist: pytest; extra == "dev"
-Requires-Dist: pytest-cov; extra == "dev"
-Requires-Dist: ruff; extra == "dev"
+Requires-Dist: Faker==40.1.0; extra == "dev"
+Requires-Dist: pre-commit==4.5.1; extra == "dev"
+Requires-Dist: pytest==9.0.2; extra == "dev"
+Requires-Dist: pytest-cov==7.0.0; extra == "dev"
+Requires-Dist: ruff==0.14.10; extra == "dev"
 Dynamic: license-file
 
 # unifi-network-maps
@@ -38,13 +37,14 @@ Dynamic UniFi -> Mermaid network maps generated from LLDP topology.
 
 ## Setup
 
-- Python >= 3.10
+- Python >= 3.13
 - Virtualenv required
 
 ```bash
 python -m venv .venv
 source .venv/bin/activate
-pip install -e .
+pip install -r requirements-build.txt
+pip install -e . -c constraints.txt
 ```
 
 Local install (non-editable):
@@ -101,6 +101,15 @@ Isometric SVG output:
 
 ```bash
 unifi-network-maps --format svg-iso --output ./network.svg
+
+# Single-page MkDocs output (ports included, no clients)
+unifi-network-maps --format mkdocs --output ./docs/unifi-network.md
+
+# MkDocs output (map + legend + gateway/switch port tables)
+unifi-network-maps --format mkdocs --output ./docs/unifi-network.md
+
+# Include wired clients in the port tables
+unifi-network-maps --format mkdocs --include-clients --output ./docs/unifi-network.md
 ```
 
 SVG size overrides:
@@ -118,12 +127,61 @@ Legend only:
 unifi-network-maps --legend-only --stdout
 ```
 
+## Examples (mock data)
+
+These examples are generated from `examples/mock_data.json` (safe, anonymized fixture).
+Mock generation requires dev dependencies (`pip install -r requirements-dev.txt -c constraints.txt`).
+Regenerate the fixture + SVG with `make mock-data`.
+
+Generate mock data (dev-only, uses Faker):
+
+```bash
+unifi-network-maps --generate-mock examples/mock_data.json --mock-seed 1337
+```
+
+Generate the isometric SVG:
+
+```bash
+unifi-network-maps --mock-data examples/mock_data.json \
+  --include-ports --include-clients --format svg-iso \
+  --output examples/output/network_ports_clients_iso.svg
+```
+
+![Isometric network example](examples/output/network_ports_clients_iso.svg)
+
+Mermaid example with ports:
+
+```mermaid
+graph TB
+  core_switch["Core Switch"] ---|"Core Switch: Port 7 (AP Attic) <-> AP Attic: Port 1 (Core Switch)"| ap_attic["AP Attic"];
+  core_switch["Core Switch"] ---|"Core Switch: Port 3 (AP Living Room) <-> AP Living Room: Port 1 (Core Switch)"| ap_living_room["AP Living Room"];
+  cloud_gateway["Cloud Gateway"] ---|"Cloud Gateway: Port 9 (Core Switch) <-> Core Switch: Port 1 (Cloud Gateway)"| core_switch["Core Switch"];
+  class cloud_gateway node_gateway;
+  class core_switch node_switch;
+  class ap_living_room node_ap;
+  class ap_attic node_ap;
+  classDef node_gateway fill:#ffe3b3,stroke:#d98300,stroke-width:1px;
+  classDef node_switch fill:#d6ecff,stroke:#3a7bd5,stroke-width:1px;
+  classDef node_ap fill:#d7f5e7,stroke:#27ae60,stroke-width:1px;
+  classDef node_client fill:#f2e5ff,stroke:#7f3fbf,stroke-width:1px;
+  classDef node_other fill:#eeeeee,stroke:#8f8f8f,stroke-width:1px;
+  classDef node_legend font-size:10px;
+  linkStyle 0 stroke:#1e88e5,stroke-width:2px,arrowhead:none;
+  linkStyle 1 stroke:#1e88e5,stroke-width:2px,arrowhead:none;
+```
+
 ## Local install check
 
 ```bash
 pip install .
 ```
 
+## Dev
+
+```bash
+pip install -r requirements-dev.txt -c constraints.txt
+```
+
 ## Release
 
 Build and upload to PyPI:
@@ -164,6 +222,14 @@ The CLI groups options by category (`Source`, `Functional`, `Mermaid`, `SVG`, `O
 Source:
 - `--site`: override `UNIFI_SITE`.
 - `--env-file`: load environment variables from a specific `.env` file.
+- `--mock-data`: use mock data JSON instead of the UniFi API.
+Mock:
+- `--generate-mock`: write mock data JSON and exit.
+- `--mock-seed`: seed for deterministic mock generation.
+- `--mock-switches`: number of switches to generate.
+- `--mock-aps`: number of access points to generate.
+- `--mock-wired-clients`: number of wired clients to generate.
+- `--mock-wireless-clients`: number of wireless clients to generate.
 
 Functional:
 - `--include-ports`: show port labels (Mermaid shows both ends; SVG shows compact labels).
@@ -174,6 +240,8 @@ Functional:
 Mermaid:
 - `--direction LR|TB`: diagram direction for Mermaid (default TB).
 - `--group-by-type`: group nodes by gateway/switch/AP in Mermaid subgraphs.
+- `--legend-scale`: scale legend font/link sizes for Mermaid outputs (default 1.0).
+- `--legend-style auto|compact|diagram`: legend rendering mode (auto uses compact for mkdocs).
 - `--legend-only`: render just the legend as a separate Mermaid graph (Mermaid only).
 
 SVG:
@@ -181,9 +249,10 @@ SVG:
 - `--theme-file`: load a YAML theme for Mermaid + SVG colors (see `examples/theme.yaml` and `examples/theme-dark.yaml`).
 
 Output:
-- `--format mermaid|svg|svg-iso|lldp-md`: output format (default mermaid).
+- `--format mermaid|svg|svg-iso|lldp-md|mkdocs`: output format (default mermaid).
 - `--stdout`: write output to stdout.
 - `--markdown`: wrap Mermaid output in a code fence.
+- `--mkdocs-sidebar-legend`: write assets to place the compact legend in the MkDocs right sidebar.
 
 Debug:
 - `--debug-dump`: dump gateway + sample devices to stderr for debugging.
@@ -228,5 +297,10 @@ svg:
       to: "#b6dcff"
 ```
 
+## MkDocs Material example
+
+See `examples/mkdocs/` for a ready-to-use setup that renders Mermaid diagrams
+with Material for MkDocs, including a sample `unifi-network` page and legend.
+
 The built-in themes live at `src/unifi_network_maps/assets/themes/default.yaml` and
 `src/unifi_network_maps/assets/themes/dark.yaml`.

{unifi_network_maps-1.3.1.dist-info → unifi_network_maps-1.4.1.dist-info}/RECORD

@@ -1,7 +1,8 @@
-unifi_network_maps/__init__.py,sha256=-ypEJktJToAL9by62JJKWEzDo_KPCQtmE5kwFgX24z4,22
+unifi_network_maps/__init__.py,sha256=BqOI5y46o1G1RWC9bF1DPL-YM68lGYPmZt1pn6FZFZs,22
+unifi_network_maps/__main__.py,sha256=XsOjaqslAVgyVlOTokjVddZ2iT8apZXpJ_OB-9WEEe4,179
 unifi_network_maps/adapters/__init__.py,sha256=nzx1KsiYalL_YuXKE6acW8Dj5flmMg0-i4gyYO0gV54,22
 unifi_network_maps/adapters/config.py,sha256=Bx9JDZxxY7Gjxyb8FDT0dxiKfgXt_TmzTDbgvpwB53s,1548
-unifi_network_maps/adapters/unifi.py,sha256=DH-rI66eCfUbM7AFaRhrU-dkuO1Z83aezMorcXzF5eM,4344
+unifi_network_maps/adapters/unifi.py,sha256=H-yANmXaXoQjItVKZaAP44ATREZ2LtPrz_M48wAcTqI,7020
 unifi_network_maps/assets/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 unifi_network_maps/assets/icons/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 unifi_network_maps/assets/icons/access-point.svg,sha256=RJOgO2s9Ino5lWRrh4V7q8Jdwffros5bQq3UeDuQYF4,742
@@ -51,25 +52,28 @@ unifi_network_maps/assets/themes/dark.yaml,sha256=F86A25kd0VSCCpN4jcMZxPWWtqNC5f
 unifi_network_maps/assets/themes/default.yaml,sha256=F2Jj18NmdaJ_zyERvGAn8NEWBwapjtozrtZUxayd5AU,849
 unifi_network_maps/cli/__init__.py,sha256=2FdmLMpYFh_7P0ew2LnieLANf6ni43Ht9FKzYUDiNis,770
 unifi_network_maps/cli/__main__.py,sha256=nK_jh78VW3h3DRvSpjzpcf64zkCqniP2k82xUR9Hw2I,147
-unifi_network_maps/cli/main.py,sha256=kz6Wrc1k6uspDZc1Hhi51K9sMh74p9tl8nMfLD2-pDQ,10232
+unifi_network_maps/cli/main.py,sha256=xAPFmzxjNbpwrR_lyLv66m0EqrUy7KFYZ20Dt8Q2NhE,19896
 unifi_network_maps/io/__init__.py,sha256=nzx1KsiYalL_YuXKE6acW8Dj5flmMg0-i4gyYO0gV54,22
 unifi_network_maps/io/debug.py,sha256=wTSGMARfVh_U2R5vD-n9DjwQHdhMpypmVvoXRUdy68k,1461
 unifi_network_maps/io/export.py,sha256=v3x6mSXmbO3dWtNQv4nGNGVqMCIE0mvTBGTKsNJBg6o,352
+unifi_network_maps/io/mock_data.py,sha256=uiQ8Ta8oxs5D1MUA1ONWmp09sxH0-FNlz3SJBXMeezo,714
+unifi_network_maps/io/mock_generate.py,sha256=xKaPRj-STtI154SMTPP9iCl0s7AVZekX4uPb-bMxRvA,8508
 unifi_network_maps/model/__init__.py,sha256=nzx1KsiYalL_YuXKE6acW8Dj5flmMg0-i4gyYO0gV54,22
 unifi_network_maps/model/labels.py,sha256=m_k8mbzWtOSDOjjHhLUqwIw93pg98HAtGtHkiERXmek,1135
-unifi_network_maps/model/lldp.py,sha256=H_HMia0aYolK-gYx61Td873IbFXmrQw3_qOvpzBfVog,2707
+unifi_network_maps/model/lldp.py,sha256=SrPW5XC2lfJgaGeVx-KnSFNltyok7gIWWQNg1SkOaj4,3300
 unifi_network_maps/model/ports.py,sha256=o3NBlXcC5VV5iPWJsO4Ll1mRKJZC0f8zTHdlkkE34GU,609
-unifi_network_maps/model/topology.py,sha256=ibbYwSmfQrvs0oUIwpSl-rH7JtYet_Uoy_iU1Hw1KXA,22263
+unifi_network_maps/model/topology.py,sha256=TxHWR4JmAcvD9yOaiq87qwnTukstCaAxziJMyOmtnak,25424
 unifi_network_maps/render/__init__.py,sha256=nzx1KsiYalL_YuXKE6acW8Dj5flmMg0-i4gyYO0gV54,22
-unifi_network_maps/render/lldp_md.py,sha256=BK_4TwP-bdfU6aTsvlSkTojT8v3tegxEhH84URCou_c,8444
-unifi_network_maps/render/mermaid.py,sha256=HgLH6psy9Dw19usuoz8zo0VHK054RCWgAzldAnn4EIw,5544
+unifi_network_maps/render/device_ports_md.py,sha256=JP2Sjvq-O9h20RPygr7WEMp2R1XhLe_iw3gfgoD-SDM,15151
+unifi_network_maps/render/lldp_md.py,sha256=0CwFz1KPeU8gpu_wslPsvR3j6yunC4XX1uRETrctveI,9595
+unifi_network_maps/render/mermaid.py,sha256=zXSPkjHxFuQk4s5ENtqSobiXiMur4Tiq1aYVa7aUrhk,8158
 unifi_network_maps/render/mermaid_theme.py,sha256=QReSBFoYSIz7vgAwyHx-9f4ucbSgMTGvo1Ffa2ZfzDQ,1527
 unifi_network_maps/render/svg.py,sha256=9TIuo63EJCoHO6Mwm26dLLcfsvTpOZaZkUegDIxv6ts,33018
 unifi_network_maps/render/svg_theme.py,sha256=Si1ArM3v_-wAvHZyLFPiOZ0ohQRd6ezIckwC3_b-WIw,2684
 unifi_network_maps/render/theme.py,sha256=-cPvj9dfmOpBD3Ohpye_yTBWxXtsE0-g73mekqoh5kA,3606
-unifi_network_maps-1.3.1.dist-info/licenses/LICENSE,sha256=mYo1siIIfIwyfdOuK2-Zt0ij2xBTii2hnpeTu79nD80,1074
-unifi_network_maps-1.3.1.dist-info/METADATA,sha256=mwjTmTKNyKK9QUsjXXvFm6B0NAQnNBcxsN3g4ft-vqo,5848
-unifi_network_maps-1.3.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-unifi_network_maps-1.3.1.dist-info/entry_points.txt,sha256=cdJ7jsBgNgHxSflYUOqgz5BbvuM0Nnh-x8_Hbyh_LFg,67
-unifi_network_maps-1.3.1.dist-info/top_level.txt,sha256=G0rUX1PNfVCn1u-KtB6QjFQHopCOVLnPMczvPOoraHg,19
-unifi_network_maps-1.3.1.dist-info/RECORD,,
+unifi_network_maps-1.4.1.dist-info/licenses/LICENSE,sha256=mYo1siIIfIwyfdOuK2-Zt0ij2xBTii2hnpeTu79nD80,1074
+unifi_network_maps-1.4.1.dist-info/METADATA,sha256=z4KBMpd033ok2Thpcfvik6qi2PMCOR2ctQBu6E791PY,9035
+unifi_network_maps-1.4.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+unifi_network_maps-1.4.1.dist-info/entry_points.txt,sha256=cdJ7jsBgNgHxSflYUOqgz5BbvuM0Nnh-x8_Hbyh_LFg,67
+unifi_network_maps-1.4.1.dist-info/top_level.txt,sha256=G0rUX1PNfVCn1u-KtB6QjFQHopCOVLnPMczvPOoraHg,19
+unifi_network_maps-1.4.1.dist-info/RECORD,,