2023-06-21 23:33:57 +02:00
|
|
|
# netbox_qrgen
|
2023-06-21 23:31:47 +02:00
|
|
|
|
2023-06-21 23:33:57 +02:00
|
|
|
NetBox plugin to generate QR codes for assets
|
2023-06-21 23:31:47 +02:00
|
|
|
|
|
|
|
CI/CD
|
|
|
|
|
|
|
|
[![status-badge](https://img.shields.io/drone/build/olofvndrhr/netbox_qrgen?label=tests&server=https%3A%2F%2Fci.44net.ch)](https://ci.44net.ch/olofvndrhr/netbox_qrgen)
|
|
|
|
[![Last Release](https://img.shields.io/github/release-date/olofvndrhr/netbox_qrgen?label=last%20release)](https://github.com/olofvndrhr/netbox_qrgen/releases)
|
|
|
|
[![Version](https://img.shields.io/github/v/release/olofvndrhr/netbox_qrgen?label=git%20release)](https://github.com/olofvndrhr/netbox_qrgen/releases)
|
|
|
|
[![Version PyPi](https://img.shields.io/pypi/v/netbox_qrgen?label=pypi%20release)](https://pypi.org/project/netbox_qrgen/)
|
|
|
|
|
|
|
|
Code Analysis
|
|
|
|
|
|
|
|
[![Quality Gate Status](https://sonarqube.44net.ch/api/project_badges/measure?project=olofvndrhr%3Anetbox_qrgen&metric=alert_status&token=f9558470580eea5b4899cf33f190eee16011346d)](https://sonarqube.44net.ch/dashboard?id=olofvndrhr%3Anetbox_qrgen)
|
|
|
|
[![Coverage](https://sonarqube.44net.ch/api/project_badges/measure?project=olofvndrhr%3Anetbox_qrgen&metric=coverage&token=f9558470580eea5b4899cf33f190eee16011346d)](https://sonarqube.44net.ch/dashboard?id=olofvndrhr%3Anetbox_qrgen)
|
|
|
|
[![Bugs](https://sonarqube.44net.ch/api/project_badges/measure?project=olofvndrhr%3Anetbox_qrgen&metric=bugs&token=f9558470580eea5b4899cf33f190eee16011346d)](https://sonarqube.44net.ch/dashboard?id=olofvndrhr%3Anetbox_qrgen)
|
|
|
|
[![Security](https://img.shields.io/snyk/vulnerabilities/github/olofvndrhr/netbox_qrgen)](https://app.snyk.io/org/olofvndrhr-t6h/project/aae9609d-a4e4-41f8-b1ac-f2561b2ad4e3)
|
|
|
|
|
|
|
|
Meta
|
|
|
|
|
|
|
|
[![Code style](https://img.shields.io/badge/code%20style-black-black)](https://github.com/psf/black)
|
|
|
|
[![Linter](https://img.shields.io/badge/linter-ruff-red)](https://github.com/charliermarsh/ruff)
|
|
|
|
[![Types](https://img.shields.io/badge/types-pyright-blue)](https://github.com/microsoft/pyright)
|
|
|
|
[![License](https://img.shields.io/badge/license-MIT-9400d3.svg)](https://snyk.io/learn/what-is-mit-license/)
|
|
|
|
[![Compatibility](https://img.shields.io/pypi/pyversions/netbox_qrgen)](https://pypi.org/project/netbox_qrgen/)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
## Description
|
|
|
|
|
|
|
|
test
|
|
|
|
|
|
|
|
## Features (not complete)
|
|
|
|
|
|
|
|
- test
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
### With GitHub
|
|
|
|
|
|
|
|
```sh
|
|
|
|
git clone https://github.com/olofvndrhr/netbox_qrgen.git # clone the repository
|
|
|
|
|
|
|
|
cd netbox_qrgen # go in the directory
|
|
|
|
|
|
|
|
pip install -r requirements.txt # install required packages
|
|
|
|
|
|
|
|
# on windows
|
|
|
|
python netbox_qrgen.py <options>
|
|
|
|
# on unix
|
|
|
|
python3 netbox_qrgen.py <options>
|
|
|
|
```
|
|
|
|
|
|
|
|
### With pip ([pypi](https://pypi.org/project/netbox_qrgen/))
|
|
|
|
|
|
|
|
```sh
|
|
|
|
python3 -m pip install netbox_qrgen # download the package from pypi
|
|
|
|
|
|
|
|
python3 -m mangadlp <args> # start the script as a module
|
|
|
|
OR
|
|
|
|
netbox_qrgen <args> # call script directly
|
|
|
|
OR
|
|
|
|
mangadlp <args> # call script directly
|
|
|
|
```
|
|
|
|
|
|
|
|
## Contribution / Bugs
|
|
|
|
|
|
|
|
For suggestions for improvement, just open a pull request.
|
|
|
|
|
|
|
|
If you want to add support for a new site, there is an api [template file](contrib/api_template.py) which you can use.
|
|
|
|
And more infos and tools are in the contrib [README.md](contrib/README.md)
|
|
|
|
|
|
|
|
Otherwise, you can open an issue with the name of the site which you want support for (not guaranteed to be
|
|
|
|
implemented).
|
|
|
|
|
|
|
|
If you encounter any bugs, also just open an issue with a description of the problem.
|
|
|
|
|
|
|
|
## TODO's
|
|
|
|
|
|
|
|
- test
|