2023-11-18 16:59:00 +00:00
|
|
|
# paperless-asn-qr-codes
|
|
|
|
|
|
|
|
`paperless-asn-qr-codes` is a command line utility for generating ASN labels
|
2024-01-22 06:56:37 +00:00
|
|
|
for paperless with both a human-readable representation, as well as a QR code
|
2023-11-18 16:59:00 +00:00
|
|
|
for machine consumption. The labels are Avery 4731 labels.
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
|
|
```console
|
|
|
|
pip install paperless-asn-qr-codes
|
|
|
|
```
|
|
|
|
|
2024-01-22 06:56:37 +00:00
|
|
|
## Usage
|
|
|
|
|
|
|
|
```
|
|
|
|
usage: paperless-asn-qr-codes [-h] [--format {averyL4731,avery5160,avery5161,avery5163,avery5167,avery5371}] [--border] start_asn output_file
|
|
|
|
|
|
|
|
CLI Tool for generating paperless ASN labels with QR codes
|
|
|
|
|
|
|
|
positional arguments:
|
|
|
|
start_asn The value of the first ASN
|
|
|
|
output_file The output file to write to (default: labels.pdf)
|
|
|
|
|
|
|
|
options:
|
|
|
|
-h, --help show this help message and exit
|
|
|
|
--format {averyL4731,avery5160,avery5161,avery5163,avery5167,avery5371}, -f {averyL4731,avery5160,avery5161,avery5163,avery5167,avery5371}
|
|
|
|
--border, -b Display borders around labels, useful for debugging the printer alignment
|
|
|
|
```
|
|
|
|
|
|
|
|
### Mandatory arguments
|
|
|
|
|
|
|
|
- `<start_asn>`: The value of the first ASN to generate
|
|
|
|
|
|
|
|
### Optional arguments
|
|
|
|
|
|
|
|
- `<output_file>`: The name of the output file to write to (default: labels.pdf)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
- `-h`, `--help`: Shows the help message
|
|
|
|
- `-f`, `--format`: Selects the format of the output sheet (see [Supported Sheets](#supported-sheets))
|
|
|
|
- `-b`, `--border`: Generates the borders around the labels to help debug alignment issues (see [Tips & Tricks](#tips--tricks))
|
|
|
|
|
2023-11-25 14:12:31 +00:00
|
|
|
## Supported Sheets
|
2024-01-22 06:56:37 +00:00
|
|
|
Some different sheet types are supported with the `-f`/`--format` argument, however, not all are tested.
|
2023-11-25 14:12:31 +00:00
|
|
|
|
2024-01-22 06:56:37 +00:00
|
|
|
The default is Avery L4731.
|
2023-11-25 14:12:31 +00:00
|
|
|
|
|
|
|
Currently tested and known working are:
|
|
|
|
- Avery L4731 (DIN A4 Labels)
|
|
|
|
|
2023-11-25 14:36:17 +00:00
|
|
|
## Tips & Tricks
|
|
|
|
|
|
|
|
In case your printer has alignment issues, you can generate a PDF with borders around the labels by using the
|
2024-01-22 06:56:37 +00:00
|
|
|
`-b`/`--border` option.
|
2023-11-25 14:36:17 +00:00
|
|
|
|
2023-11-18 16:59:00 +00:00
|
|
|
## License
|
|
|
|
|
|
|
|
`paperless-asn-qr-codes` is distributed under the terms of the
|
|
|
|
[GPL-3.0](https://spdx.org/licenses/GPL-3.0.html) license.
|