Metadata-Version: 2.4
Name: netbox-qrcode
Version: 1.0.0
Summary: QR Code generation for netbox objects
Home-page: https://github.com/netbox-community/netbox-qrcode
Author: Nikolay Yuzefovich
Author-email: mgk.kolek@gmail.com
License: Apache-2.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: Django
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: qrcode
Requires-Dist: Pillow
Requires-Dist: packaging
Provides-Extra: test
Requires-Dist: Django<6.1,>=6.0; extra == "test"
Provides-Extra: docs
Requires-Dist: mkdocs-material<10.0,>=9.5; extra == "docs"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# NetBox QR Code

This [NetBox](http://netboxlabs.com/oss/netbox/) plugin generates printable QR code labels for objects in NetBox. Labels are rendered directly on an object's detail view, and each object type can carry several independent label designs — different sizes, different content, or different layouts for the same device.

Supported object types are Device, Module, Rack, Cable, Location, Power Feed, and Power Panel, plus Asset when [netbox-inventory](https://github.com/ArnesSI/netbox-inventory) is installed.

See the [compatibility matrix](COMPATIBILITY.md) for supported NetBox versions.

[![Downloads](https://static.pepy.tech/badge/netbox-qrcode)](https://pepy.tech/project/netbox-qrcode)
[![Downloads](https://static.pepy.tech/badge/netbox-qrcode/month)](https://pepy.tech/project/netbox-qrcode)
[![Downloads](https://static.pepy.tech/badge/netbox-qrcode/week)](https://pepy.tech/project/netbox-qrcode)

![Device QR Code](docs/img/qrcode.png)

## Installation

Brief installation instructions are provided below. For a complete installation guide, please refer to the included [documentation](docs/installation.md).

1. Activate the NetBox virtual environment:

```
$ source /opt/netbox/venv/bin/activate
```

2. Install the plugin from [PyPI](https://pypi.org/project/netbox-qrcode/):

```
$ pip install netbox-qrcode
```

3. Add `netbox_qrcode` to `PLUGINS` in `configuration.py`:

```python
PLUGINS = [
    # ...
    'netbox_qrcode',
]
```

4. Add `netbox-qrcode` to `local_requirements.txt` so the plugin survives future upgrades, then restart NetBox:

```
$ sudo systemctl restart netbox netbox-rq
```

This plugin requires no database migrations.

## Documentation

* [Introduction](docs/index.md) — what the plugin does and how labels are assembled
* [Installation](docs/installation.md) — full installation guide
* [Configuration](docs/configuration.md) — reference for every configuration parameter
* [Label Examples](docs/label-examples.md) — worked label designs you can copy
* [Printing](docs/printing.md) — printer and browser settings for accurate output
* [Change Log](CHANGELOG.md)

## Contributing

Issues and pull requests are welcomed. Please note that pull requests are accepted only for approved issues.

This repository follows the same two-branch model as NetBox itself:

* `feature` — active development of future releases. **Base your pull requests on this branch.**
* `main` — the released code. Releases are cut from here; `feature` is merged into `main` to release.

GitHub defaults the base branch to `main`, so remember to switch the base to `feature` when opening a pull request.
