bucket_6B/python-nextbox-ui-plugin

   1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
   2
   3 NAMEBASE=               python-nextbox-ui-plugin
   4 VERSION=                0.13.0
   5 KEYWORDS=               python
   6 VARIANTS=               v11 v12
   7 SDESC[v11]=             Topology visualization plugin for Netbox (3.11)
   8 SDESC[v12]=             Topology visualization plugin for Netbox (3.12)
   9 HOMEPAGE=               https://github.com/iDebugAll/nextbox-ui-plugin
  10 CONTACT=                Python_Automaton[python@ironwolf.systems]
  11
  12 DOWNLOAD_GROUPS=        main
  13 SITES[main]=            PYPI/n/nextbox-ui-plugin
  14 DISTFILE[1]=            nextbox_ui_plugin-0.13.0.tar.gz:main
  15 DF_INDEX=               1
  16 SPKGS[v11]=             single
  17 SPKGS[v12]=             single
  18
  19 OPTIONS_AVAILABLE=      PY311 PY312
  20 OPTIONS_STANDARD=       none
  21 VOPTS[v11]=             PY311=ON PY312=OFF
  22 VOPTS[v12]=             PY311=OFF PY312=ON
  23
  24 DISTNAME=               nextbox_ui_plugin-0.13.0
  25
  26 GENERATED=              yes
  27
  28 [PY311].USES_ON=                        python:v11,sutools
  29
  30 [PY312].USES_ON=                        python:v12,sutools
  31
  32 [FILE:3301:descriptions/desc.single]
  33 # NextBox UI Plugin
  34
  35 A topology visualization plugin for [NetBox] powered by [NextUI] Toolkit.
  36 Netbox v2.8.0+ is required.
  37
  38 # Installation
  39
  40 General installation steps and considerations follow the [official
  41 guidelines].
  42
  43 ### Package Installation from PyPi
  44
  45 Assuming you use a Virtual Environment for Netbox:
  46 ```
  47 $ source /opt/netbox/venv/bin/activate
  48 (venv) $ pip3 install nextbox-ui-plugin
  49 ```
  50
  51 ### Package Installation from Source Code
  52 The source code is available on [GitHub].<br/>
  53 Download and install the package. Assuming you use a Virtual Environment
  54 for Netbox:
  55 ```
  56 $ git clone https://github.com/iDebugAll/nextbox-ui-plugin
  57 $ cd nextbox-ui-plugin
  58 $ source /opt/netbox/venv/bin/activate
  59 (venv) $ pip3 install .
  60 ```
  61
  62 To ensure NextBox UI plugin is automatically re-installed during future
  63 upgrades, create a file named `local_requirements.txt` (if not already
  64 existing) in the NetBox root directory (alongside `requirements.txt`) and
  65 list the `nextbox-ui-plugin` package:
  66
  67 ```no-highlight
  68 # echo nextbox-ui-plugin >> local_requirements.txt
  69 ```
  70
  71 ### Enable the Plugin
  72 In a global Netbox **configuration.py** configuration file, update or add
  73 PLUGINS parameter:
  74 ```python
  75 PLUGINS = [
  76     'nextbox_ui_plugin',
  77 ]
  78 ```
  79
  80 Optionally, update a PLUGINS_CONFIG parameter in **configuration.py** to
  81 rewrite default plugin behavior:
  82 ```python
  83 #PLUGINS_CONFIG = {
  84 #    'nextbox_ui_plugin': {
  85 #        'layers_sort_order': (
  86 #            ADD YOUR SETTINGS HERE
  87 #            layer_sort_order is a tuple
  88 #        ),
  89 #        'icon_model_map': {
  90 #            ADD YOUR SETTINGS HERE
  91 #            icon_model_map is a dict
  92 #        },
  93 #        'icon_role_map': {
  94 #            ADD YOUR SETTINGS HERE
  95 #            icon_role_map is a dict
  96 #        }
  97 #        'undisplayed_device_role_slugs': (
  98 # #          ADD YOUR SETTINGS HERE
  99 #            undisplayed_device_role_slugs value is a list or a tuple
 100 #            Listed device role slugs are hidden on initial view load,
 101 #            you may then hide/display any layer with a control button.
 102 #        ),
 103 #        'undisplayed_device_tags': (
 104 #           ADD YOUR SETTINGS HERE
 105 #           undisplayed_device_tags value is a list or a tuple of regex
 106 strings.
 107 #           Devices with tags matching any of listed regular expressions
 108 are hidden
 109 #           on initial view load, you may then hide/display any layer with
 110 a control button.
 111 #        ),
 112 #        'select_layers_list_include_device_tags': (
 113 #           ADD YOUR SETTINGS HERE
 114 #           select_layers_list_include_device_tags value is a list or a
 115 tuple of regex strings.
 116 #           Use this parameter to control tags listed in Select Layers
 117 menu.
 118 #           If specified, it works as allow list.
 119 #        ),
 120 #        'select_layers_list_exclude_device_tags': (
 121 #           ADD YOUR SETTINGS HERE
 122 #           select_layers_list_exclude_device_tags value is a list or a
 123 tuple of regex strings.
 124 #           Use this parameter to control tags listed in Select Layers
 125 menu.
 126 #           If specified, it filters out matched tags from the list, except
 127 ones mathcing 'undisplayed_device_tags'.
 128 #        ),
 129 #        'DISPLAY_PASSIVE_DEVICES': True|False,
 130 #        'DISPLAY_LOGICAL_MULTICABLE_LINKS': True|False,
 131 #        'DISPLAY_UNCONNECTED': True|False,
 132 #        'INITIAL_LAYOUT': 'vertical'|'horizontal'|'auto'
 133
 134
 135 [FILE:110:distinfo]
 136 468d9c56965caa376ea8dfa6841bf9e6c6d42c2d576cb4c6b23d9407c0a61980      1120005 nextbox_ui_plugin-0.13.0.tar.gz
 137