bucket_C1/python-netbox-qrcode

   1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
   2
   3 NAMEBASE=               python-netbox-qrcode
   4 VERSION=                0.0.13
   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/86/ae/30f1fb2cea5acc930247c0f4b2d8c12dc00f7dce30e7541410dda11562c3
  14 DISTFILE[1]=            netbox_qrcode-0.0.13-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.13.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:3399: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 [Downloads]
  44 [Downloads]
  45 [Downloads]
  46
  47 ## Compatibility
  48
  49 | Plugin Version | NetBox Version | Tested on                      |
  50 | ------------- |:-------------| :-----:|
  51 | 0.0.11          | >= 3.7.0        | 3.7.x |
  52 | 0.0.13          | >= 4.0.2        | v4.0.2                   |
  53
  54 ## Installation
  55
  56 If Netbox was installed according to the standard installation
  57 instructions. It may be necessary to activate the virtual environment.
  58
  59 ```
  60 source /opt/netbox/venv/bin/activate
  61 `
  62
  63 The plugin is available as a Python package in pypi and can be installed
  64 with pip
  65
  66 `
  67 pip install netbox-qrcode
  68 ```
  69 Enable the plugin in /opt/netbox/netbox/netbox/configuration.py:
  70 ```
  71 PLUGINS = ['netbox_qrcode']
  72 ```
  73 Restart NetBox and add `netbox-qrcode` to your local_requirements.txt
  74
  75 ## Configuration
  76
  77 The following options are available:
  78
  79 * `with_text`: Boolean (default True). Text label will be added to QR code
  80 image if enabled.
  81 * `text_template`: Jinja2 template with {{ obj }}  as context, using it
  82 ignores `text_fields` and `custom_text`
  83 * `text_fields`: List of String (default ['name']). Text fields of an
  84 object that will be added as text label to QR image. It's possible to use
  85 custom field values.
  86 * `font`: String (default TahomaBold) Font name for text label ( Some font
  87 include in package, see fonts dir).
  88 * `text_location`: Where to render the text, relative to the QR code.
  89 Valid values are `"right"` (default), `"left"`", `"up"`, and `"down"`.
  90 * `custom_text`: String or None (default None) additional text label to QR
  91 code image (will be added after text_fields).
  92 * `qr_version`: Integer (default 1) parameter is an integer from 1 to 40
  93 that controls the size of
  94 the QR Code (the smallest, version 1, is a 21x21 matrix).
  95 * `qr_error_correction`: Integer (default 0),  controls the error
  96 correction used for the
  97 QR Code. The following values are available:
  98
  99    1 - About 7% or less errors can be corrected.
 100    0 - About 15% or less errors can be corrected.
 101    2 - About 30% or less errors can be corrected.
 102    3 - About 25% or less errors can be corrected.
 103
 104 * `qr_box_size`: Integer (default 6),  controls how many pixels each "box"
 105 of the QR code
 106 is.
 107 * `qr_border`: Integer (default 4),  controls how many boxes thick the
 108 border should be
 109 (the default is 4, which is the minimum according to the specs).
 110
 111 ### Per object options
 112
 113 Per object options override default options. Per object options dictionary
 114 can contains any of default options inside.
 115
 116 * `device`: Dict or None (default {'text_fields': ['name', 'serial']}), set
 117 None to disble QR code
 118 * `rack`: Dict or None (default {'text_fields': ['name']}) , set None to
 119 disble QR code
 120 * `cable`: Dict or None ( defaul {'text_fields': ['_termination_a_device',
 121 'termination_a', '_termination_b_device', 'termination_b',]}), set None to
 122 disble QR code
 123
 124 Configuration example:
 125 ```
 126 PLUGINS_CONFIG = {
 127     'netbox_qrcode': {
 128         'with_text': True,
 129         'text_fields': ['name', 'serial'],
 130         'font': 'ArialMT',
 131         'font_size': 12, # If the value is 0 or the line does not exist,
 132 then the text is automatically adjusted
 133         'custom_text': 'Property of SomeCompany\ntel.8.800333554-CALL',
 134         'text_location': 'up',
 135         'qr_version': 1,
 136         'qr_error_correction': 0,
 137
 138
 139 [FILE:116:distinfo]
 140 d806e525cf9869c89c79806c09994e53b0e1f2492be1310c4a932e0e650fc71b      1690199 netbox_qrcode-0.0.13-py3-none-any.whl
 141