bucket_C1/python-netbox-qrcode

   1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
   2
   3 NAMEBASE=               python-netbox-qrcode
   4 VERSION=                0.0.8
   5 KEYWORDS=               python
   6 VARIANTS=               py310 py311
   7 SDESC[py310]=           QR Code generation for netbox objects (3.10)
   8 SDESC[py311]=           QR Code generation for netbox objects (3.11)
   9 HOMEPAGE=               https://github.com/k01ek/netbox-qrcode
  10 CONTACT=                Python_Automaton[python@ironwolf.systems]
  11
  12 DOWNLOAD_GROUPS=        main
  13 SITES[main]=            PYPIWHL/74/30/99cab1384360941633ede7de558650f84dc0bb6b4c49129f47e3d8f91d0d
  14 DISTFILE[1]=            netbox_qrcode-0.0.8-py3-none-any.whl:main
  15 DF_INDEX=               1
  16 SPKGS[py310]=           single
  17 SPKGS[py311]=           single
  18
  19 OPTIONS_AVAILABLE=      PY310 PY311
  20 OPTIONS_STANDARD=       none
  21 VOPTS[py310]=           PY310=ON PY311=OFF
  22 VOPTS[py311]=           PY310=OFF PY311=ON
  23
  24 DISTNAME=               netbox_qrcode-0.0.8.dist-info
  25
  26 GENERATED=              yes
  27
  28 [PY310].RUN_DEPENDS_ON=                 python-qrcode:single:py310
  29                                         python-Pillow:single:py310
  30 [PY310].USES_ON=                        python:py310,wheel
  31
  32 [PY311].RUN_DEPENDS_ON=                 python-qrcode:single:py311
  33                                         python-Pillow:single:py311
  34 [PY311].USES_ON=                        python:py311,wheel
  35
  36 [FILE:3235:descriptions/desc.single]
  37 # Netbox QR Code Plugin
  38
  39 [Netbox] plugin for generate QR codes for objects: Rack, Device, Cable.
  40
  41 This plugin depends on [qrcode] and [Pillow] python library
  42
  43 ## Compatibility
  44
  45 This plugin in compatible with [NetBox] 2.8 and later.
  46
  47 ## Installation
  48
  49 The plugin is available as a Python package in pypi and can be installed
  50 with pip
  51
  52 ```
  53 pip install netbox-qrcode
  54 ```
  55 Enable the plugin in /opt/netbox/netbox/netbox/configuration.py:
  56 ```
  57 PLUGINS = ['netbox_qrcode']
  58 ```
  59 Restart NetBox and add `netbox-qrcode` to your local_requirements.txt
  60
  61 ## Configuration
  62
  63 The following options are available:
  64
  65 * `with_text`: Boolean (default True). Text label will be added to QR code
  66 image if enabled.
  67 * `text_fields`: List of String (default ['name']). Text fields of an
  68 object that will be added as text label to QR image. It's possible to use
  69 custom field values.
  70 * `font`: String (default TahomaBold) Font name for text label ( Some font
  71 include in package, see fonts dir).
  72 * `text_location`: Where to render the text, relative to the QR code.
  73 Valid values are `"right"` (default), `"left"`", `"up"`, and `"down"`.
  74 * `custom_text`: String or None (default None) additional text label to QR
  75 code image (will be added after text_fields).
  76 * `qr_version`: Integer (default 1) parameter is an integer from 1 to 40
  77 that controls the size of
  78 the QR Code (the smallest, version 1, is a 21x21 matrix).
  79 * `qr_error_correction`: Integer (default 0),  controls the error
  80 correction used for the
  81 QR Code. The following values are available:
  82
  83    1 - About 7% or less errors can be corrected.
  84    0 - About 15% or less errors can be corrected.
  85    2 - About 30% or less errors can be corrected.
  86    3 - About 25% or less errors can be corrected.
  87
  88 * `qr_box_size`: Integer (default 6),  controls how many pixels each "box"
  89 of the QR code
  90 is.
  91 * `qr_border`: Integer (default 4),  controls how many boxes thick the
  92 border should be
  93 (the default is 4, which is the minimum according to the specs).
  94
  95 ### Per object options
  96
  97 Per object options override default options. Per object options dictionary
  98 can contains any of default options inside.
  99
 100 * `device`: Dict or None (default {'text_fields': ['name', 'serial']}), set
 101 None to disble QR code
 102 * `rack`: Dict or None (default {'text_fields': ['name']}) , set None to
 103 disble QR code
 104 * `cable`: Dict or None ( defaul {'text_fields': ['_termination_a_device',
 105 'termination_a', '_termination_b_device', 'termination_b',]}), set None to
 106 disble QR code
 107
 108 Configuration example:
 109 ```
 110 PLUGINS_CONFIG = {
 111     'netbox_qrcode': {
 112         'with_text': True,
 113         'text_fields': ['name', 'serial'],
 114         'font': 'ArialMT',
 115         'custom_text': 'Property of SomeCompany\ntel.8.800333554-CALL',
 116         'text_location': 'up',
 117         'qr_version': 1,
 118         'qr_error_correction': 0,
 119         'qr_box_size': 4,
 120         'qr_border': 4,
 121         # per object options
 122         'cable': None,  # disable QR code for Cable object
 123         'rack': {
 124             'text_fields': [
 125                 'site',
 126                 'name',
 127                 'facility_id',
 128                 'tenant',
 129                 'cf.cf_name'
 130            ]
 131         },
 132         'device': {
 133             'qr_box_size': 6,
 134             'custom_text': None,
 135         }
 136     }
 137
 138
 139 [FILE:115:distinfo]
 140 999e3f4cb68dcd5c1b16bf9bfc47a336892c4df8583ed2a1a8b599b8b5120535      1689679 netbox_qrcode-0.0.8-py3-none-any.whl
 141