The light Python report builder.
Converts data into formatted text (PDF, XLSX, DOCX, HTML):
data = {'data_source1':[{'col1': 'value row1', ....}, ...],
'data_source2':[{'col_1': 'valie_row1', ....}, ...],
}
Available formatting (styling options):
"style": {
"font-family": "Arial",
"font-size": "10pt",
"font-weight": "normal", # bold
"text-decoration": "", # underline
"font-style": "", # italic
"color": "black", # font color
"background": "white", # background color
"border-color": "black", # border color
"border-width": "1 1 1 1",
"padding": "0.05cm 0.05cm 0.05cm 0.05cm",
"text-align": "left",
"vertical-align": "top",
}
Concept
The report definition consists of sections (Report, Pages, Columns, Rows, Cells).
Each section inherits style from previous and may override some styling options.
*see examples in folder test_data*
Report: # top-level report object containing the base style
Pages: # page size, margins, and page-level styles
Columns: # column widths: fixed, %, or auto-width; supports styles
Rows: # row heights: auto, fixed, minimum, or maximum; supports styles
# rows may be data-bound and can include subsections:
# header, footer, group-header, group-footer
Cells: # contain plain text and data placeholders — {col1} (f-strings style)
# support aggregate functions — {sum:col1}
# support basic HTML formatting: <b> <i> <u> <br>
Rows:
Cells: # cells can be merged (span)
...
Columns:
...
Pages:
...
...```
---
## Main API (`Q2Report`)
### Initialization
```python
from q2report.q2report import Q2Report
report = Q2Report(style={...})
Adding Pages and Columns
report.add_page(page_width=21, page_height=29.7, page_margin_left=2, page_margin_right=1)
report.add_columns(page_index=0, widths=[5, 5, 5], style={...})
Adding Rows and Cells
rows = report.add_rows(page_index=0, columns_index=0, heights=[1, 1, 1], style={...})
rows.set_cell(0, 0, "{col1}", style={"font-weight": "bold"})
rows.set_cell(1, 0, "{sum:col2}", format="F2")
Or directly via report:
report.set_cell(0, 1, "Some value", page_index=0, columns_index=0, rows_index=0)
Data Binding
- Use
{column_name}in cell data to bind to data source columns. - Use
{sum:column_name}for aggregation in table footers or group footers.
Grouping and Aggregation
rows.add_table_group(
groupby="col1",
header=Q2Report_rows(...),
footer=Q2Report_rows(...)
)
Rendering
report.run(output_file="output.pdf", data=data)
- Supported output types:
"html","pdf","xlsx","docx"
Features
- Flexible styling: Inherit and override styles at any level.
- Data-driven: Bind data sources to tables, rows, and cells.
- Aggregates: Built-in support for
{sum:col}and similar formulas. - Grouping: Group rows by one or more columns, with group headers/footers.
- Images: Embed images using
{q2image(path)}or cell format"I". - Multi-format output: Export to HTML, PDF, XLSX, DOCX.
- Custom formulas: Use Python expressions in
{...}.
Example
from q2report.q2report import Q2Report
report = Q2Report()
report.add_page()
report.add_columns(widths=[5, 5, 5])
rows = report.add_rows(heights=[1, 1, 1])
rows.set_cell(0, 0, "Header 1", style={"font-weight": "bold"})
rows.set_cell(0, 1, "Header 2", style={"font-weight": "bold"})
rows.set_cell(1, 0, "{col1}")
rows.set_cell(1, 1, "{col2:F2}")
report.run(output_file="report.pdf", data={"data_source": [{"col1": "A", "col2": 123456}]})
Advanced
- Custom styles: Use
Q2Report.make_style(...)to generate style dicts. - Direct JSON: You can load report definitions from JSON files or strings.
- Accessing data: Use
report.d.<dataset>for advanced row access in formulas.
See Also
- test_data/ for more examples.
- q2report.py for full API and docstrings.
Metadata
Release files for q2report 0.1.67
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| q2report-0.1.67.tar.gz | 43.1 kB | Without provenance | Details for q2report-0.1.67.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| q2report-0.1.67-py3-none-any.whl | Python 3 | none | any | Details for q2report-0.1.67-py3-none-any.whl |
Total release size: 94.0 kB
Release files / q2report-0.1.67.tar.gz
| Download URL | q2report-0.1.67.tar.gz |
|---|---|
| Size | 43.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
dea368e38dfb3f56fb7adf16156a4ca560145260ce98dcc6dfafcf35fc316d9e
|
|
BLAKE2b-256 checksum How to use checksums |
2d6ea77b2121a09acf26e41f541b81f9a548f162d6dfe03976958805044d0209
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.5.0 CPython/3.11.7 Windows/10
|
Release files / q2report-0.1.67-py3-none-any.whl
| Download URL | q2report-0.1.67-py3-none-any.whl |
|---|---|
| Size | 50.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
fa5dad2d2e1deea8036d7ceacf939a89992fea1237da7ba0892f95bb99e0156f
|
|
BLAKE2b-256 checksum How to use checksums |
c1eace7f4ade8d3dd8d98a5c56917d1e9a3078817aade6cc7827175a2e40da63
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.5.0 CPython/3.11.7 Windows/10
|
Security for q2report 0.1.67
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.