xtensive/dpa.report.builder repository overview

⁠DPA.REPORT.BUILDER

DPA.REPORT.BUILDER is a Docker image designed for generating reports using Jupyter notebooks, Python scripts, and a headless web browser. This versatile tool allows you to create reports in various formats and execute custom scripts seamlessly. It serves as the pivotal element that enhances your reporting proficiency used together with DPA real time monitoring and production control system⁠.

⁠Use cases:

• ⁠Build pdf using Jupyter book⁠ (default mode)

docker run --rm  -e HOST_API_KEY=key -e HOST_ADDRESS=http://host.docker.internal -v .:/report/src xtensive/dpa.report.builder

• ⁠Build pdf using nbconvert⁠

docker run --rm  -e HOST_API_KEY=key -e HOST_ADDRESS=http://host.docker.internal -v .:/report/src xtensive/dpa.report.builder jupyter nbconvert --execute --no-input --to webpdf ./src/ReportTemplate.ipynb

• ⁠Run custom script

docker run --rm -v .:/report xtensive/dpa.report.builder python3 ./script.py

• ⁠Start interactive development

docker run --rm -it -p 8888:80 -v .:/report/src xtensive/dpa.report.builder jupyter notebook --port 80 --allow-root --ip 0.0.0.0

Access the Jupyter notebook at http://localhost:8888⁠. Be sure to copy the login token from the console message.

⁠Conventional options (-e arguments)

• HOST_API_KEY: Use this environment variable to pass your API token.
• HOST_ADDRESS: Use this environment variable to specify the DPA.Host server address, which is accessible within the container (localhost for Linux, host.docker.internal for Windows)
• You can also configure report-specific build options using the report_filters.json file within your report workspace.

⁠Avaliable nbconvert exporters (--to argument):

• webpdf: Export to PDF via HTML page creation and Chromium rendering.
• pdf: Export to PDF via LaTeX document conversion.
• latex: Export to LaTeX document format.
• html: Generate a raw single-page HTML report.