mirror of
https://github.com/entropia/paperless-asn-qr-codes.git
synced 2024-05-20 07:46:42 +00:00
Update README.md
Add documentation for the command line arguments and options
This commit is contained in:
parent
279a3ee0ea
commit
278046ae90
41
README.md
41
README.md
|
@ -1,7 +1,7 @@
|
||||||
# paperless-asn-qr-codes
|
# paperless-asn-qr-codes
|
||||||
|
|
||||||
`paperless-asn-qr-codes` is a command line utility for generating ASN labels
|
`paperless-asn-qr-codes` is a command line utility for generating ASN labels
|
||||||
for paperless with both a human readable representation, as well as a QR code
|
for paperless with both a human-readable representation, as well as a QR code
|
||||||
for machine consumption. The labels are Avery 4731 labels.
|
for machine consumption. The labels are Avery 4731 labels.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
@ -10,10 +10,41 @@ for machine consumption. The labels are Avery 4731 labels.
|
||||||
pip install paperless-asn-qr-codes
|
pip install paperless-asn-qr-codes
|
||||||
```
|
```
|
||||||
|
|
||||||
## Supported Sheets
|
## Usage
|
||||||
Some different sheet types are supported with the `--format` argument, however, not all are tested.
|
|
||||||
|
|
||||||
Default is Avery L4731.
|
```
|
||||||
|
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))
|
||||||
|
|
||||||
|
## Supported Sheets
|
||||||
|
Some different sheet types are supported with the `-f`/`--format` argument, however, not all are tested.
|
||||||
|
|
||||||
|
The default is Avery L4731.
|
||||||
|
|
||||||
Currently tested and known working are:
|
Currently tested and known working are:
|
||||||
- Avery L4731 (DIN A4 Labels)
|
- Avery L4731 (DIN A4 Labels)
|
||||||
|
@ -21,7 +52,7 @@ Currently tested and known working are:
|
||||||
## Tips & Tricks
|
## Tips & Tricks
|
||||||
|
|
||||||
In case your printer has alignment issues, you can generate a PDF with borders around the labels by using the
|
In case your printer has alignment issues, you can generate a PDF with borders around the labels by using the
|
||||||
`--border` option.
|
`-b`/`--border` option.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue