reportist/plugins/consumables/README.md

18 lines
906 B
Markdown

# Consumables CSV plugin
Renders a French stock inventory from a Snipe-IT consumables CSV export. The
input must have `Name`, `Category`, `Supplier`, `Model No.`, `Remaining`,
`Min. QTY`, and `Location` columns. `Remaining` and `Min. QTY` must contain
nonnegative integers for named rows. Unnamed totals rows are skipped.
```sh
./build.sh render consumables plugins/consumables/tests/fixtures/sample.csv --output /tmp/consumables.pdf
./build.sh render-all consumables /path/to/exports --output-dir /tmp/consumables-pdfs
```
Run these commands from the Reportist root. `--force` permits replacement;
`--theme NAME` selects a palette from `visual/themes.yaml`. The output is A4
landscape with repeating table headers, stock status, and summary metrics.
Stock at or below the minimum is critical; up to 1.5 times the minimum is low.
The `Bureaux` location is displayed as `BUREAU REGIE`, matching the POC.