How-to guides¶
Recipes for specific tasks. Each assumes you have dpm-xbrl installed and
know what a report is; the getting started
tutorial covers the basics. Every example runs against the files in
docs/samples.
| Guide | Use it to |
|---|---|
| Read a report | Read paths, directories, bytes and XML instances; handle errors and warnings. |
| Read large reports as frames | Read packages with millions of facts into polars frames in seconds. |
| Check EBA filing rules | List the filing rules a report breaks and stop a CI pipeline with --fail-on. |
| Add your own filing findings | Record taxonomy-aware findings next to the ones the readers make. |
| Convert between formats | Write xBRL-CSV packages and XBRL-XML instances. |
| Resolve metadata offline | Read concepts, dimensions and units from local taxonomy packages. |
| Handle untrusted uploads | Accept reports from users safely, with limits and one error type. |
| Validate a report with dpm-xl | Evaluate DPM-XL validation rules on the facts of a report. |