bucket_C1/python-netbox-qrcode

   1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
   2
   3 NAMEBASE=               python-netbox-qrcode
   4 VERSION=                0.0.11
   5 KEYWORDS=               python
   6 VARIANTS=               v11 v12
   7 SDESC[v11]=             QR Code generation for netbox objects (3.11)
   8 SDESC[v12]=             QR Code generation for netbox objects (3.12)
   9 HOMEPAGE=               https://github.com/k01ek/netbox-qrcode
  10 CONTACT=                Python_Automaton[python@ironwolf.systems]
  11
  12 DOWNLOAD_GROUPS=        main
  13 SITES[main]=            PYPIWHL/b4/94/3f6c1e5549f0362cb28d01c403433be13c0f4f30c7f4590224250e0b8411
  14 DISTFILE[1]=            netbox_qrcode-0.0.11-py3-none-any.whl: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=               netbox_qrcode-0.0.11.dist-info
  25
  26 GENERATED=              yes
  27
  28 [PY311].RUN_DEPENDS_ON=                 python-qrcode:single:v11
  29                                         python-Pillow:single:v11
  30 [PY311].USES_ON=                        python:v11,wheel
  31
  32 [PY312].RUN_DEPENDS_ON=                 python-qrcode:single:v12
  33                                         python-Pillow:single:v12
  34 [PY312].USES_ON=                        python:v12,wheel
  35
  36 [FILE:3346: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 If Netbox was installed according to the standard installation
  50 instructions. It may be necessary to activate the virtual environment.
  51
  52 ```
  53 source /opt/netbox/venv/bin/activate
  54 `
  55
  56 The plugin is available as a Python package in pypi and can be installed
  57 with pip
  58
  59 `
  60 pip install netbox-qrcode
  61 ```
  62 Enable the plugin in /opt/netbox/netbox/netbox/configuration.py:
  63 ```
  64 PLUGINS = ['netbox_qrcode']
  65 ```
  66 Restart NetBox and add `netbox-qrcode` to your local_requirements.txt
  67
  68 ## Configuration
  69
  70 The following options are available:
  71
  72 * `with_text`: Boolean (default True). Text label will be added to QR code
  73 image if enabled.
  74 * `text_template`: Jinja2 template with {{ obj }}  as context, using it
  75 ignores `text_fields` and `custom_text`
  76 * `text_fields`: List of String (default ['name']). Text fields of an
  77 object that will be added as text label to QR image. It's possible to use
  78 custom field values.
  79 * `font`: String (default TahomaBold) Font name for text label ( Some font
  80 include in package, see fonts dir).
  81 * `text_location`: Where to render the text, relative to the QR code.
  82 Valid values are `"right"` (default), `"left"`", `"up"`, and `"down"`.
  83 * `custom_text`: String or None (default None) additional text label to QR
  84 code image (will be added after text_fields).
  85 * `qr_version`: Integer (default 1) parameter is an integer from 1 to 40
  86 that controls the size of
  87 the QR Code (the smallest, version 1, is a 21x21 matrix).
  88 * `qr_error_correction`: Integer (default 0),  controls the error
  89 correction used for the
  90 QR Code. The following values are available:
  91
  92    1 - About 7% or less errors can be corrected.
  93    0 - About 15% or less errors can be corrected.
  94    2 - About 30% or less errors can be corrected.
  95    3 - About 25% or less errors can be corrected.
  96
  97 * `qr_box_size`: Integer (default 6),  controls how many pixels each "box"
  98 of the QR code
  99 is.
 100 * `qr_border`: Integer (default 4),  controls how many boxes thick the
 101 border should be
 102 (the default is 4, which is the minimum according to the specs).
 103
 104 ### Per object options
 105
 106 Per object options override default options. Per object options dictionary
 107 can contains any of default options inside.
 108
 109 * `device`: Dict or None (default {'text_fields': ['name', 'serial']}), set
 110 None to disble QR code
 111 * `rack`: Dict or None (default {'text_fields': ['name']}) , set None to
 112 disble QR code
 113 * `cable`: Dict or None ( defaul {'text_fields': ['_termination_a_device',
 114 'termination_a', '_termination_b_device', 'termination_b',]}), set None to
 115 disble QR code
 116
 117 Configuration example:
 118 ```
 119 PLUGINS_CONFIG = {
 120     'netbox_qrcode': {
 121         'with_text': True,
 122         'text_fields': ['name', 'serial'],
 123         'font': 'ArialMT',
 124         'custom_text': 'Property of SomeCompany\ntel.8.800333554-CALL',
 125         'text_location': 'up',
 126         'qr_version': 1,
 127         'qr_error_correction': 0,
 128         'qr_box_size': 4,
 129         'qr_border': 4,
 130         # per object options
 131         'cable': None,  # disable QR code for Cable object
 132         'rack': {
 133             'text_fields': [
 134                 'site',
 135                 'name',
 136                 'facility_id',
 137
 138
 139 [FILE:116:distinfo]
 140 179d84e35dd3b6ee529efc080223da252f2799ae2c6d42f06c3671700604a24d      1689994 netbox_qrcode-0.0.11-py3-none-any.whl
 141