unifi-network-maps 1.4.0__py3-none-any.whl → 1.4.2__py3-none-any.whl

{unifi_network_maps-1.4.0.dist-info → unifi_network_maps-1.4.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: unifi-network-maps
-Version: 1.4.0
+Version: 1.4.2
 Summary: Dynamic UniFi -> network maps in mermaid or svg
 Author: Merlijn
 License-Expression: MIT
@@ -25,31 +25,38 @@ Requires-Dist: python-dotenv==1.2.1
 Requires-Dist: PyYAML==6.0.3
 Provides-Extra: dev
 Requires-Dist: Faker==40.1.0; extra == "dev"
+Requires-Dist: behave==1.3.3; 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"
+Requires-Dist: pyright==1.1.408; extra == "dev"
+Requires-Dist: ruff==0.14.11; extra == "dev"
 Dynamic: license-file
 
 # unifi-network-maps
 
-Dynamic UniFi -> Mermaid network maps generated from LLDP topology.
+[![CI](https://github.com/merlijntishauser/unifi-network-maps/actions/workflows/ci.yml/badge.svg)](https://github.com/merlijntishauser/unifi-network-maps/actions/workflows/ci.yml)
+[![CodeQL](https://github.com/merlijntishauser/unifi-network-maps/actions/workflows/codeql.yml/badge.svg)](https://github.com/merlijntishauser/unifi-network-maps/actions/workflows/codeql.yml)
+[![Publish](https://github.com/merlijntishauser/unifi-network-maps/actions/workflows/publish.yml/badge.svg)](https://github.com/merlijntishauser/unifi-network-maps/actions/workflows/publish.yml)
+[![PyPI](https://img.shields.io/pypi/v/unifi-network-maps.svg)](https://pypi.org/project/unifi-network-maps/)
 
-## Setup
+Dynamic UniFi network maps generated from LLDP topology. Output can be a range of options including Markdown,
+Mermaid, SVG (including an Isometric view), and MkDocs.
 
-- Python >= 3.13
-- Virtualenv required
+## Installation
+
+PyPI:
 
 ```bash
-python -m venv .venv
-source .venv/bin/activate
-pip install -r requirements-build.txt
-pip install -e . -c constraints.txt
+pip install unifi-network-maps
 ```
 
-Local install (non-editable):
+From source:
 
 ```bash
+python -m venv .venv
+source .venv/bin/activate
+pip install -r requirements-build.txt
 pip install .
 ```
 
@@ -63,6 +70,7 @@ export UNIFI_SITE=default
 export UNIFI_USER=local_admin
 export UNIFI_PASS=********
 export UNIFI_VERIFY_SSL=false
+export UNIFI_REQUEST_TIMEOUT_SECONDS=10
 ```
 
 Use a custom env file:
@@ -71,7 +79,7 @@ Use a custom env file:
 unifi-network-maps --env-file ./site.env --stdout
 ```
 
-## Usage
+## Quickstart
 
 Basic map (tree layout by LLDP hops):
 
@@ -85,6 +93,8 @@ Write Markdown for notes tools:
 unifi-network-maps --markdown --output ./network.md
 ```
 
+## Usage
+
 Show ports + clients:
 
 ```bash
@@ -101,23 +111,29 @@ 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 (ports included, no clients):
 
-# MkDocs output (map + legend + gateway/switch port tables)
+```bash
 unifi-network-maps --format mkdocs --output ./docs/unifi-network.md
+```
 
-# Include wired clients in the port tables
+MkDocs output with clients:
+
+```bash
 unifi-network-maps --format mkdocs --include-clients --output ./docs/unifi-network.md
 ```
 
-SVG size overrides:
+MkDocs output with dual Mermaid blocks for Material theme switching:
 
 ```bash
-unifi-network-maps --format svg --svg-width 1400 --svg-height 900 --output ./network.svg
+unifi-network-maps --format mkdocs --mkdocs-dual-theme --output ./docs/unifi-network.md
+```
 
-# LLDP tables for troubleshooting
+LLDP tables for troubleshooting:
+
+```bash
 unifi-network-maps --format lldp-md --output ./lldp.md
 ```
 
@@ -142,9 +158,7 @@ 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
+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)
@@ -170,50 +184,14 @@ graph TB
   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:
-
-```bash
-python -m pip install build twine
-python -m build
-twine upload dist/*
-```
-
-Tagging is recommended before release:
-
-```bash
-git tag -a vX.Y.Z -m "vX.Y.Z"
-git push origin vX.Y.Z
-```
-
-See `LICENSES.md` for third-party license info.
-
-## Installation
-
-PyPI: https://pypi.org/project/unifi-network-maps/
+## MkDocs Material example
 
-```bash
-pip install unifi-network-maps
-```
+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.
 
-Then run:
+The built-in themes live at `src/unifi_network_maps/assets/themes/default.yaml` and
+`src/unifi_network_maps/assets/themes/dark.yaml`.
 
-```bash
-unifi-network-maps --help
-```
 
 ## Options
 
@@ -223,6 +201,7 @@ 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.
@@ -236,6 +215,7 @@ Functional:
 - `--include-clients`: add active wired clients as leaf nodes.
 - `--client-scope wired|wireless|all`: which client types to include (default wired).
 - `--only-unifi`: only include neighbors that are UniFi devices.
+- `--no-cache`: disable UniFi API cache reads and writes.
 
 Mermaid:
 - `--direction LR|TB`: diagram direction for Mermaid (default TB).
@@ -253,25 +233,13 @@ Output:
 - `--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.
+- `--mkdocs-dual-theme`: render light/dark Mermaid blocks for Material theme switching.
+- `--mkdocs-timestamp-zone`: timezone for mkdocs timestamp (`Europe/Amsterdam` default; use `off` to disable).
 
 Debug:
 - `--debug-dump`: dump gateway + sample devices to stderr for debugging.
 - `--debug-sample N`: number of non-gateway devices in debug dump (default 2).
 
-## Notes
-
-- Default output is top-to-bottom (TB) and rendered as a hop-based tree from the gateway(s).
-- Nodes are color-coded by type (gateway/switch/AP/client) with a sensible default palette.
-- PoE links are highlighted in blue and annotated with a power icon when detected from `port_table`.
-- Wireless client links render as dashed lines to indicate the last-known upstream.
-- SVG output uses vendored device glyphs from `src/unifi_network_maps/assets/icons`.
-- Isometric SVG output uses MIT-licensed icons from `markmanx/isopacks`.
-- SVG port labels render inside child nodes for readability.
-
-## AI Disclosure
-
-This project used OpenAI Codex as a coding assistant for portions of the implementation and documentation.
-
 ## Theme file
 
 Example theme YAML (override only the values you want):
@@ -297,10 +265,17 @@ svg:
       to: "#b6dcff"
 ```
 
-## MkDocs Material example
+## Notes
 
-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.
+- Default output is top-to-bottom (TB) and rendered as a hop-based tree from the gateway(s).
+- Nodes are color-coded by type (gateway/switch/AP/client) with a sensible default palette.
+- PoE links are highlighted in blue and annotated with a power icon when detected from `port_table`.
+- Wireless client links render as dashed lines to indicate the last-known upstream.
+- SVG output uses vendored device glyphs from `src/unifi_network_maps/assets/icons`.
+- Isometric SVG output uses MIT-licensed icons from `markmanx/isopacks`.
+- SVG port labels render inside child nodes for readability.
 
-The built-in themes live at `src/unifi_network_maps/assets/themes/default.yaml` and
-`src/unifi_network_maps/assets/themes/dark.yaml`.
+
+## AI Disclosure
+
+This project used OpenAI Codex as a coding assistant for portions of the implementation and documentation.

{unifi_network_maps-1.4.0.dist-info → unifi_network_maps-1.4.2.dist-info}/RECORD

@@ -1,7 +1,8 @@
-unifi_network_maps/__init__.py,sha256=8UhoYEXHs1Oai7BW_ExBmuwWnRI-yMG_u1fQAXMizHQ,22
+unifi_network_maps/__init__.py,sha256=qjngKmjcwKn1c_BwAouVdai-TbnuKZo56EbqRdILxaI,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=H-yANmXaXoQjItVKZaAP44ATREZ2LtPrz_M48wAcTqI,7020
+unifi_network_maps/adapters/unifi.py,sha256=olrs-K7EWK7Uhib8pjtPnkZg3LhnnSz-lcGuHG8RsOI,15140
 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,28 +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=xAPFmzxjNbpwrR_lyLv66m0EqrUy7KFYZ20Dt8Q2NhE,19896
+unifi_network_maps/cli/main.py,sha256=y053K-EbnAvxZ073-AEHhAGYWSvc4-UcoDTKpaBsvZY,27319
 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/debug.py,sha256=eUVs6GLfs6VqI6ma8ra7NLhC3q4ek2K8OSRLnpQDF9s,1745
+unifi_network_maps/io/export.py,sha256=2vURunQDja-_fKKMb-gQG-n34aeM8GFprNJqcGaP4qg,843
 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=SrPW5XC2lfJgaGeVx-KnSFNltyok7gIWWQNg1SkOaj4,3300
 unifi_network_maps/model/ports.py,sha256=o3NBlXcC5VV5iPWJsO4Ll1mRKJZC0f8zTHdlkkE34GU,609
-unifi_network_maps/model/topology.py,sha256=TxHWR4JmAcvD9yOaiq87qwnTukstCaAxziJMyOmtnak,25424
+unifi_network_maps/model/topology.py,sha256=JfpY6Pam_pgqnnmsBmzy3oDv4OCi4Ezc8msxvp5Z5NQ,26784
 unifi_network_maps/render/__init__.py,sha256=nzx1KsiYalL_YuXKE6acW8Dj5flmMg0-i4gyYO0gV54,22
-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/device_ports_md.py,sha256=QoRiuP9l2CH8BYRHXRaWM5wyucAURz-zByzwMetnND4,15473
+unifi_network_maps/render/lldp_md.py,sha256=Eg5c5SWEwTfEn6AN0fOfD3f41GlsqwZQRO8AzIXFQf4,10753
+unifi_network_maps/render/mermaid.py,sha256=IqHgTqXVzHzcWwypwBfPqKx1L5QxLrjEgDiooAvE6HU,9286
 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.py,sha256=RHmSmlKxrS8m3-zYsTJu-GZugsZt8X8TDsPpK7DA6tg,38807
 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.4.0.dist-info/licenses/LICENSE,sha256=mYo1siIIfIwyfdOuK2-Zt0ij2xBTii2hnpeTu79nD80,1074
-unifi_network_maps-1.4.0.dist-info/METADATA,sha256=GFS_WROOChSadIp9uXqlYg_eUUSwRAGxJXuxwle3Ou0,9035
-unifi_network_maps-1.4.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-unifi_network_maps-1.4.0.dist-info/entry_points.txt,sha256=cdJ7jsBgNgHxSflYUOqgz5BbvuM0Nnh-x8_Hbyh_LFg,67
-unifi_network_maps-1.4.0.dist-info/top_level.txt,sha256=G0rUX1PNfVCn1u-KtB6QjFQHopCOVLnPMczvPOoraHg,19
-unifi_network_maps-1.4.0.dist-info/RECORD,,
+unifi_network_maps-1.4.2.dist-info/licenses/LICENSE,sha256=mYo1siIIfIwyfdOuK2-Zt0ij2xBTii2hnpeTu79nD80,1074
+unifi_network_maps-1.4.2.dist-info/METADATA,sha256=GcoBldeKBD7f9fRhpf7RZYpvTFY7MU7Fvi3uCSmai9U,9529
+unifi_network_maps-1.4.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+unifi_network_maps-1.4.2.dist-info/entry_points.txt,sha256=cdJ7jsBgNgHxSflYUOqgz5BbvuM0Nnh-x8_Hbyh_LFg,67
+unifi_network_maps-1.4.2.dist-info/top_level.txt,sha256=G0rUX1PNfVCn1u-KtB6QjFQHopCOVLnPMczvPOoraHg,19
+unifi_network_maps-1.4.2.dist-info/RECORD,,