VSCode Breakpoints and Create auto Netbox User for developer and Chapter for Debeloper

.dockerignore

@@ -0,0 +1,29 @@
+**/__pycache__
+**/.venv
+**/.classpath
+**/.dockerignore
+**/.env
+**/.git
+**/.gitignore
+**/.project
+**/.settings
+**/.toolstarget
+**/.vs
+**/.vscode
+**/*.*proj.user
+**/*.dbmdl
+**/*.jfm
+**/bin
+**/charts
+**/docker-compose*
+**/compose*
+**/Dockerfile*
+**/node_modules
+**/npm-debug.log
+**/obj
+**/secrets.dev.yaml
+**/values.dev.yaml
+LICENSE
+
+# Part of Setup.py and therefore important for plugin installation.
+# README.md

.github/workflows/pub-pypi.yml

@@ -10,10 +10,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@main
-    - name: Set up Python 3.7
+    - name: Set up Python 3.12
       uses: actions/setup-python@v1
       with:
-        python-version: 3.7
+        python-version: 3.12
     - name: Install pypa/build
       run: >-
         python -m

.vscode/launch.json

@@ -0,0 +1,26 @@
+// Is required for debugging Docker-Compose in VSCode.
+{    
+    "configurations": [
+        {
+
+            "name": "Docker: Python - Django",
+            "type": "debugpy",
+            "request": "attach",
+            "connect": {
+                "host": "localhost",
+                "port": 5678
+            },
+
+            "pathMappings": [
+                {
+                    "localRoot": "${workspaceFolder}",
+                    "remoteRoot": "/source"
+                }
+            ],
+
+            "django": true,
+
+            "justMyCode": true,
+        }
+    ]
+}

.vscode/tasks.json

@@ -0,0 +1,19 @@
+// Is required for debugging Docker-Compose in VSCode.
+{
+    "version": "2.0.0",
+    "tasks": [
+        { 
+            "label": "docker-run: debug",
+            "type": "docker-compose",
+            "dockerCompose": {
+            "up": {
+                "detached": true,
+                "build": true
+            },
+            "files": [
+                "${workspaceFolder}/develop/docker-compose.yml",
+                ]
+            }
+        }
+    ]
+  }

CODEOWNERS

@@ -1 +1 @@
-*    @k01ek @cruse1977 @natm
+*    @k01ek @cruse1977 @cvitan

Makefile

@@ -1,46 +1,70 @@
+# General: The Makefile is used for plugin development is used to simplify the execution of command sequences.
+# Recommended VSCode plugin: Makefile-Tools (extension ID: ms-vscode.makefile-tools)
+# To trigger a Makefile command (target), the following line must be written in the terminal window of VSCode, for example:
+# make cbuild
+
+# Parameter
 PYTHON_VER?=3.12
-NETBOX_VER?=v4.0.2
+NETBOX_VER?=v4.3.1
 
 NAME=netbox-qrcode
 
 COMPOSE_FILE=./develop/docker-compose.yml
+COMPOSE_FILE_DEBUG=./develop/docker-compose-debug.yml
 BUILD_NAME=netbox_qrcode
 VERFILE=./netbox_qrcode/version.py
 
-
+# Build Docker with the specific Python and Netbox version
 cbuild:
 	docker-compose -f ${COMPOSE_FILE} \
 		-p ${BUILD_NAME} build \
 		--build-arg netbox_ver=${NETBOX_VER} \
 		--build-arg python_ver=${PYTHON_VER}
 
-debug:
+# Start Docker with terminal window output
+debug: cbuild
 	@echo "Starting Netbox .. "
 	docker-compose -f ${COMPOSE_FILE} -p ${BUILD_NAME} up
 
+# Start Docker with terminal window output.
+# Brakepoints in e.g. Python files are supported in VSCode. Changes in Python and HTML are applied after saving.
+debug-vscode: cbuild
+	@echo "Starting Netbox debug for VSCode.. "
+	docker-compose -f ${COMPOSE_FILE} -p ${BUILD_NAME} -f ${COMPOSE_FILE_DEBUG} up
+# --build
+
+# Start Docker without connecting to the terminal window. (Runs independently of the terminal window.).
 start:
 	@echo "Starting Netbox in detached mode.. "
 	docker-compose -f ${COMPOSE_FILE} -p ${BUILD_NAME} up -d
 
+# Stop Docker Container
 stop:
 	docker-compose -f ${COMPOSE_FILE} -p ${BUILD_NAME} down
 
+# Stop Docker and remove containers
 destroy:
 	docker-compose -f ${COMPOSE_FILE} -p ${BUILD_NAME} down
 	docker volume rm -f ${BUILD_NAME}_pgdata_netbox_qrcode
 
+# Calls the Netbox shell. Exit with exit()
+# NetBox includes a Python shell within which objects can be directly queried, created, modified, and deleted.
 nbshell:
 	docker-compose -f ${COMPOSE_FILE} -p ${BUILD_NAME} run netbox python manage.py nbshell
 
+# Calls the Python shell. Exit with exit()
 shell:
 	docker-compose -f ${COMPOSE_FILE} -p ${BUILD_NAME} run netbox python manage.py shell
 
+# To create the Django Superuser to be able to log on to Netbox Web.
 adduser:
 	docker-compose -f ${COMPOSE_FILE} -p ${BUILD_NAME} run netbox python manage.py createsuperuser
 
+# Django collectstatic
 collectstatic:
 	docker-compose -f ${COMPOSE_FILE} -p ${BUILD_NAME} run netbox python manage.py collectstatic
 
+# Migrate the Netbox system depending on the Django model
 migrations:
 	docker-compose -f ${COMPOSE_FILE} -p ${BUILD_NAME} up -d postgres
 	docker-compose -f ${COMPOSE_FILE} -p ${BUILD_NAME} \

README.md

@@ -1,6 +1,6 @@
 # Netbox QR Code Plugin
 
-[Netbox](https://github.com/netbox-community/netbox) plugin for generate QR codes for objects: Rack, Device, Cable.
+[Netbox](https://github.com/netbox-community/netbox) plugin for generate QR codes for objects: Device, Module, Cable, Powerfeed, Powerpanel, Location 
 
 This plugin depends on [qrcode](https://github.com/lincolnloop/python-qrcode) and [Pillow](https://github.com/python-pillow/Pillow) python library
 
@@ -10,10 +10,14 @@ This plugin depends on [qrcode](https://github.com/lincolnloop/python-qrcode) an
 
 ## Compatibility
 
-| Plugin Version | NetBox Version | Tested on                      |
-| ------------- |:-------------| :-----:|
-| 0.0.11          | >= 3.7.0        | 3.7.x |
-| 0.0.13          | >= 4.0.2        | v4.0.2                   |
+| Plugin Version | NetBox Version | Tested on |
+| ------------- |:-------------| :-----------:|
+| 0.0.11        | 3.7.x        | 3.7.x        |
+| 0.0.14        | 4.0.x        | 4.0.11       |
+| 0.0.15        | 4.1.x        | 4.1.6        |
+| 0.0.17        | 4.2.x        | 4.2.4        |
+| 0.0.18        | 4.3.x        | 4.3.1        |
+
 
 ## Installation
 
@@ -36,80 +40,72 @@ Restart NetBox and add `netbox-qrcode` to your local_requirements.txt
 
 ## Configuration
 
-The following options are available:
+### Label Design
 
-* `with_text`: Boolean (default True). Text label will be added to QR code image if enabled.
-* `text_template`: [Jinja2](https://jinja.palletsprojects.com/) template with {{ obj }} as context for device, rack, etc., using it ignores `text_fields` and `custom_text`.
+Extensive label customisation is possible, it's also possible to include different labels for each object type, for example 2 labels for the Device view.
 
-  Example to output name and site in two lines with caption (See also screenshots below):
-  ```
-  'text_template': 'Name: {{ obj.name }}\nSite: {{ obj.site }}',
-  ```
-* `text_fields`: List of String (default ['name']). Text fields of an object that will be added as text label to QR image. It's possible to use custom field values.
-* `font`: String (default TahomaBold) Font name for text label ( Some font include in package, see fonts dir).
-* `text_location`: Where to render the text, relative to the QR code.  Valid values are `"right"` (default), `"left"`", `"up"`, and `"down"`.
-* `custom_text`: String or None (default None) additional text label to QR code image (will be added after text_fields).
-* `qr_version`: Integer (default 1) parameter is an integer from 1 to 40 that controls the size of
-the QR Code (the smallest, version 1, is a 21x21 matrix).
-* `qr_error_correction`: Integer (default 0),  controls the error correction used for the
-QR Code. The following values are available:
+For advice on configuration please see the two links below:
 
-   1 - About 7% or less errors can be corrected.
-   0 - About 15% or less errors can be corrected.
-   2 - About 30% or less errors can be corrected.
-   3 - About 25% or less errors can be corrected.
+- [General Configuration >>](docs/README_Subpages/README_Configuration.md)
+- [Configuration Examples  >>](docs/README_Subpages/README_Configuration_ExampleLabelConf.md)
 
-* `qr_box_size`: Integer (default 6),  controls how many pixels each "box" of the QR code
-is.
-* `qr_border`: Integer (default 4),  controls how many boxes thick the border should be
-(the default is 4, which is the minimum according to the specs).
+![Cable QR Code](/docs/img/Configuration_Label_Example_10.png)
 
-### Per object options
 
-Per object options override default options. Per object options dictionary can contains any of default options inside.
+### Printing
+
+#### Setting the label printer 
+
+If the print does not look like the preview in the Netbox, first try to get a perfect print using Word. As many printer settings also have an influence on the print result. Borderless printing is possible if the printer (e.g. thermal transfer printer) supports this.
+
+![ShowImage](/docs/img/Configuration_Printer_WordPreview.png)
+
+
+Here is an example of what needs to be considered to print borderless from a Word document. [Go to: Example Zebra ZM400 300dpi label printer and a label 56x32mm. >>](/docs/img/Configuration_Printer_ZM400.png)
+
+
+#### Setting Browser Print Settings
+
+When you press the “Print” button, there are some print properties that are added by the browser. However, these interfere with the print result. They should therefore be deactivated.
+
+##### Firefox:
+
+| Parameter                                      | Value                        |
+| ---------------------------------------------  | ---------------------------  |
+| Orientation                                    | Portrait                     |  
+| Paper size                                     | User defined                 |
+| Margins                                        | none                         |
+| Scale                                          | Fit to page width or 100%    |
+| Options --> Print headers and footers          | disable                      |
+| Options --> Print backgrounds                  | disable                      |
+
+##### Chrome:
+Chrome can alter settings between printing and the print preview, therefore the below settings are recomended
+
+| Parameter                                      | Value                        |
+| ---------------------------------------------  | ---------------------------  |
+| Layout                                         | Portrait                     |  
+| Paper size                                     | empty !!!                    |
+| Pages per sheet                                | 1                            |
+| Margins                                        | none                         |
+| Scale                                          | Default or 100%              |
+| Options --> PBackground grafics                | disable                      |
+
+![Image](/docs/img/Configuration_Browser_Print_Settings.png)
+
 
-* `device`: Dict or None (default {'text_fields': ['name', 'serial']}), set None to disble QR code
-* `rack`: Dict or None (default {'text_fields': ['name']}) , set None to disble QR code
-* `cable`: Dict or None ( defaul {'text_fields': ['_termination_a_device', 'termination_a', '_termination_b_device', 'termination_b',]}), set None to disble QR code
 
-Configuration example:
-```
-PLUGINS_CONFIG = {
-    'netbox_qrcode': {
-        'with_text': True,
-        'text_fields': ['name', 'serial'],
-        'font': 'ArialMT',
-        'font_size': 12, # If the value is 0 or the line does not exist, then the text is automatically adjusted
-        'custom_text': 'Property of SomeCompany\ntel.8.800333554-CALL',
-        'text_location': 'up',
-        'qr_version': 1,
-        'qr_error_correction': 0,
-        'qr_box_size': 4,
-        'qr_border': 4,
-        # per object options
-        'cable': None,  # disable QR code for Cable object
-        'rack': {
-            'text_fields': [
-                'site',
-                'name',
-                'facility_id',
-                'tenant',
-                'cf.cf_name'
-            ]
-        },
-        'device': {
-            'qr_box_size': 6,
-            'custom_text': None,
-        }
-    }
-}
-```
 
 ## Contributing
-Developing tools for this project based on [ntc-netbox-plugin-onboarding](https://github.com/networktocode/ntc-netbox-plugin-onboarding) repo.
 
 Issues and pull requests are welcomed.
 
+## Development
+
+You would like to help with the development of the plugin. Here you can find further information such as how to set up debugging in vscode and much more.
+
+- [Go to Development >>](docs/README_Subpages/README_Development.md)
+
 ## Screenshots
 
 Device QR code with text label
@@ -120,6 +116,3 @@ Rack QR code
 
 Cable QR code
 ![Cable QR Code](docs/img/qrcode_cable.png)
-
-Device QR code via Jinja2 "text_template" Parameter (Multiline and labeled)
-![Cable QR Code](docs/img/qrcode_text_template.png)

develop/Dockerfile

@@ -1,12 +1,14 @@
 ARG python_ver=3.12
 FROM python:${python_ver}
 
-ARG netbox_ver=master
+ARG netbox_ver=main
 ENV PYTHONUNBUFFERED 1
 
 RUN mkdir -p /opt
 
 RUN pip install --upgrade pip
+RUN pip install setuptools
+
 
 # -------------------------------------------------------------------------------------
 # Install NetBox
@@ -23,6 +25,6 @@ WORKDIR /source
 COPY . /source
 
 #RUN pip install -r requirements.txt
-RUN python setup.py develop
+RUN python -m pip install -e .
 
 WORKDIR /opt/netbox/netbox/