ReportLab Docs

https://docs.reportlab.com/
Admin
ReportLab is a Python library for generating PDFs, offering powerful tools for creating complex...
Tokens:363,384
Snippets:2,462
Trust Score:9.6
Update:2 days ago
Show doc for...
Tokens:
Raw
### Setup virtual environment and install dependencies

Source: https://docs.reportlab.com/demos/flask_reportlab/flask_reportlab/

Commands to create a Python 3.11 virtual environment, activate it, and install ReportLab Plus (rlextra) and Flask. Requires ReportLab Plus access.

```bash
python3.11 -m venv env
source env/bin/activate
pip install rlextra -i https://www.reportlab.com/pypi/
pip install flask
```

--------------------------------

### Install reportlab from ReportLab's PyPI

Source: https://docs.reportlab.com/rl-arabic/

Install the latest reportlab version (>= 4.4.0) from ReportLab's own PyPI repository to get RTL support.

```bash
pip install reportlab  -i https://www.reportlab.com/pypi
```

--------------------------------

### HTML template example (template.prep)

Source: https://docs.reportlab.com/preppy/

HTML template using Preppy syntax with {{def}} and conditional blocks. Place in a .prep file and invoke with getModule and get.

```HTML
{{def(name, sex)}}
<html><head><title>{{name}}</title></head><body>
hello my name is {{name}} and I am
{{if sex=="f":}} a gal
{{elif sex=="m":}} a guy
{{else}} neuter {{endif}}
</body></html>
```

--------------------------------

### Simple listStyle example in stylesheet

Source: https://docs.reportlab.com/tagref/tag_liststyle/

Declares a listStyle named 'example_list_style' with various bullet and indentation settings. Only relevant sections are shown; full document setup requires additional tags.

```xml
<stylesheet>
    <listStyle name="example_list_style"
               leftIndent="50"
               bulletDedent="10"
               bulletOffsetY="2"
               bulletType="a"
               bulletFontSize="13"
               bulletColor="red"
               bulletAlign="right"
               bulletFormat="%s)"
    />
</stylesheet>
```

--------------------------------

### Install specific ReportLab version

Source: https://docs.reportlab.com/install/open_source_installation/

Command to install a specific ReportLab version from PyPI. Example shows installing the last 3.x version.

```bash
pip install reportlab==X.Y.Z
```

```bash
pip installl reportlab==3.6.13
```

--------------------------------

### Install and set up from ReportLab application repository

Source: https://docs.reportlab.com/json2pdf/

Commands to clone the repository, create a virtual environment, activate it, install dependencies, and run setup-json2pdf.

```bash
$ hg clone url
```

```bash
$ python -mvirtualenv -p /path/to/desired/python .
```

```bash
$ . bin/activate
```

```bash
$ pip install -r requirements.txt
```

```bash
$ setup-json2pdf
```

--------------------------------

### Start Local Django Server

Source: https://docs.reportlab.com/rml/tutorials/aws-json-to-pdf/

Starts the Django development server locally.

```bash
python manage.py runserver
```

--------------------------------

### Set up Python environment and install dependencies

Source: https://docs.reportlab.com/rml/tutorials/xls-to-pdf/

These commands create a virtual environment, activate it, and install required packages from requirements.txt. Run them from the xls-to-pdf directory.

```bash
$ cd xls-to-pdf
```

```bash
$ python -m venv .
```

```bash
$ . bin/activate
```

```bash
$ pip install -r requirements.txt
```

--------------------------------

### Example 5 RML document

Source: https://docs.reportlab.com/rml/userguide/Chapter_7_Advanced_text/

Starts an RML document example that combines multiple features like frames, templates, and stylesheets. The code is incomplete as shown, but it sets up the XML declaration and document root.

```xml
<?xml version="1.0" encoding="iso-8859-1" standalone="no" ?>
<!DOCTYPE document SYSTEM "../rml.dtd">
<document filename="example_5.pdf">
```

--------------------------------

### Install ReportLab with pip

Source: https://docs.reportlab.com/install/open_source_installation/

Basic installation command for ReportLab 4.0 and later. Recommended to run within a virtual environment.

```bash
pip install reportlab
```

--------------------------------

### docinit example with registerTTFont and color

Source: https://docs.reportlab.com/tagref/tag_docinit/

Shows how to register a TrueType font and define a CMYK color in docinit, then use them in a stylesheet and story. The font is referenced by faceName 'standard' and the color by id 'my-color'. Only relevant sections are included; full document setup requires additional tags.

```xml
<docinit>
    <registerTTFont faceName="standard" fileName="fonts/ArialMT-Regular.ttf"/>
    <color id="my-color" CMYK=".88,.6,0,.1"/>
</docinit>
...
<stylesheet>
    <paraStyle name="text" fontName="standard" fontSize="10" textColor="my-color"/>
</stylesheet>
<story>
    <para style="text">This text will generate using the font I defined</para>
</story>
```

--------------------------------

### Install rlextra with renderpm extension (deprecated)

Source: https://docs.reportlab.com/install/ReportLab_Plus_version_installation/

Install rlextra with the deprecated renderpm extra dependency.

```bash
pip install "rlextra[renderpm]" -i https://www.reportlab.com/pypi/
```

--------------------------------

### Install rlextra with pip

Source: https://docs.reportlab.com/install/ReportLab_Plus_version_installation/

Install the ReportLab Plus package using pip with the custom index URL.

```bash
pip install rlextra -i https://www.reportlab.com/pypi/
```

--------------------------------

### Start Django Development Server

Source: https://docs.reportlab.com/rml/tutorials/fund-reports/

Run this command to start the local Django server. Then browse to http://localhost:8000/admin/ to log in and view data.

```bash
%   python manage.py runserver
```

--------------------------------

### Install rlextra from ReportLab's PyPI

Source: https://docs.reportlab.com/rl-arabic/

For commercial customers, install the latest rlextra version (>= 4.4.0) from ReportLab's PyPI repository.

```bash
pip install rlextra  -i https://www.reportlab.com/pypi
```

--------------------------------

### Input data examples

Source: https://docs.reportlab.com/clean_html/

Two sample input strings used in the PDF rendering examples.

```python
    data = "<p>This is raw data with <em>HTML</em> <b>paragraph</b></p>"
    data2 = "This is raw data with <em>HTML</em> <b>paragraph</b>"
```

--------------------------------

### Install rlextra with PyCairo extension

Source: https://docs.reportlab.com/install/ReportLab_Plus_version_installation/

Install rlextra with the PyCairo extra dependency for bitmap generation.

```bash
pip install "rlextra[pycairo]" -i https://www.reportlab.com/pypi/
```

--------------------------------

### Install ReportLab with pycairo in a virtual environment

Source: https://docs.reportlab.com/demos/calling_card/calling_card/

Sets up a Python 3.10 virtual environment and installs the ReportLab package with the optional pycairo dependency, which is needed for bitmap output.

```bash
python3.10 -m venv rptlab
source rptlab/bin/activate
pip install "reportlab[pycairo]"
```

--------------------------------

### PageCatcher pages command example

Source: https://docs.reportlab.com/pagecatcher/

Example command that lists the names of each page in c4611_sample_explain.pdf.

```bash
pagecatcher pages --pdf c4611_sample_explain.pdf
```

--------------------------------

### Install rlextra with accel extension

Source: https://docs.reportlab.com/install/ReportLab_Plus_version_installation/

Install rlextra with the accel extra dependency for C acceleration.

```bash
pip install "rlextra[accel]" -i https://www.reportlab.com/pypi/
```

--------------------------------

### RML example using <moveto> inside a <path>

Source: https://docs.reportlab.com/tagref/tag_moveto/

Shows a complete <story> with an <illustration> containing a <path> that uses <moveto> to move the drawing location. The snippet is trimmed to relevant sections; full document setup requires additional tags.

```xml
<story>
    <illustration width="100" height="100">
        <stroke color="red" width="2"/>
        <fill color="blue"/>
        <path x="10" y="10" close="no" autoclose="svg" clip="no" fillrule="even-odd" stroke="1" fill="1">
            10 90 20 90 20 10 <closePath/>
            <moveto>30 10</moveto>30 90 40 90 40 10<closePath/>
            <moveto>50 10</moveto>50 90 60 90 60 10<closePath/>
        </path>
    </illustration>
</story>
```

--------------------------------

### LinePlot Example

Source: https://docs.reportlab.com/reportlab/userguide/ch11_graphics/

A complete example showing how to create a LinePlot, set its data, axes, and line markers, and add it to a Drawing.

```APIDOC
## LinePlot Example

### Description
Creates a LinePlot chart with two data series, custom axes, and line markers.

### Code
```python
from reportlab.graphics.charts.lineplots import LinePlot
from reportlab.graphics.widgets.markers import makeMarker
from reportlab.graphics.shapes import Drawing
from reportlab.lib import colors

drawing = Drawing(400, 200)

data = [
    ((1,1), (2,2), (2.5,1), (3,3), (4,5)),
    ((1,2), (2,3), (2.5,2), (3.5,5), (4,6))
]

lp = LinePlot()
lp.x = 50
lp.y = 50
lp.height = 125
lp.width = 300
lp.data = data
lp.joinedLines = 1
lp.lines[0].symbol = makeMarker('FilledCircle')
lp.lines[1].symbol = makeMarker('Circle')
lp.lineLabelFormat = '%2.0f'
lp.strokeColor = colors.black
lp.xValueAxis.valueMin = 0
lp.xValueAxis.valueMax = 5
lp.xValueAxis.valueSteps = [1, 2, 2.5, 3, 4, 5]
lp.xValueAxis.labelTextFormat = '%2.1f'
lp.yValueAxis.valueMin = 0
lp.yValueAxis.valueMax = 7
lp.yValueAxis.valueSteps = [1, 2, 3, 5, 6]

drawing.add(lp)
```

```

--------------------------------

### Install rlbidi package

Source: https://docs.reportlab.com/rl-arabic/

Install the rlbidi package required for RTL support. Alternatively, use reportlab[bidi] or rlextra[bidi] in the previous install commands.

```bash
pip install rlbidi  -i https://www.reportlab.com/pypi
```

--------------------------------

### Complete working example of a document with TOC

Source: https://docs.reportlab.com/reportlab/userguide/ch9_other_useful_flowables/

A full example that defines a custom DocTemplate with afterFlowable to register TOC entries, builds a story with headings and a TableOfContents, and calls multiBuild to generate the PDF.

```python
from reportlab.lib.styles import ParagraphStyle as PS
from reportlab.platypus import PageBreak
from reportlab.platypus.paragraph import Paragraph
from reportlab.platypus.doctemplate import PageTemplate, BaseDocTemplate
from reportlab.platypus.tableofcontents import TableOfContents
from reportlab.platypus.frames import Frame
from reportlab.lib.units import cm

class MyDocTemplate(BaseDocTemplate):

    def __init__(self, filename, **kw):
        self.allowSplitting = 0
        BaseDocTemplate.__init__(self, filename, **kw)
        template = PageTemplate('normal', [Frame(2.5*cm, 2.5*cm, 15*cm, 25*cm, id='F1')])
        self.addPageTemplates(template)

    def afterFlowable(self, flowable):
        "Registers TOC entries."
        if flowable.__class__.__name__ == 'Paragraph':
            text = flowable.getPlainText()
            style = flowable.style.name
            if style == 'Heading1':
                self.notify('TOCEntry', (0, text, self.page))
            if style == 'Heading2':
                self.notify('TOCEntry', (1, text, self.page))

h1 = PS(name = 'Heading1',
       fontSize = 14,
       leading = 16)

h2 = PS(name = 'Heading2',
       fontSize = 12,
       leading = 14,
       leftIndent = 10)

# Build story.
story = []
toc = TableOfContents()
# For conciseness we use the same styles for headings and TOC entries
toc.levelStyles = [h1, h2]
story.append(toc)
story.append(PageBreak())
story.append(Paragraph('First heading', h1))
story.append(Paragraph('Text in first heading', PS('body')))
story.append(Paragraph('First sub heading', h2))
story.append(Paragraph('Text in first sub heading', PS('body',leftIndent=10)))
story.append(PageBreak())
story.append(Paragraph('Second sub heading', h2))
story.append(Paragraph('Text in second sub heading', PS('body',leftIndent=10)))
story.append(Paragraph('Last heading', h1))

doc = MyDocTemplate('mintoc.pdf')
doc.multiBuild(story)
```

--------------------------------

### Install ReportLab with PyCairo extension

Source: https://docs.reportlab.com/install/open_source_installation/

Installation command for ReportLab 4.0.4 and later when generating bitmaps. Adds the PyCairo extension.

```bash
pip install "reportlab[pycairo]"
```

--------------------------------

### Install Python Requirements

Source: https://docs.reportlab.com/rml/tutorials/aws-json-to-pdf/

Installs the Python packages listed in requirements.txt using pip.

```bash
pip install -r requirements.txt
```

--------------------------------

### {{script}} block examples

Source: https://docs.reportlab.com/preppy/

Shows two examples of the {{script}} tag: a single-line import and a multi-line database query. Newlines in the code are automatically indented to the proper level for the run() module.

```preppy
{{script}}import urllib2{{endscript}}
```

```preppy
{{script}}
cur = conn.cursor()
cur.execute('select * from some_table')
data = cur.fetchall()
{{endscript}}
```

--------------------------------

### PageCatcher count command example

Source: https://docs.reportlab.com/pagecatcher/

Example command that counts the pages in c4611_sample_explain.pdf.

```bash
pagecatcher count --pdf c4611_sample_explain.pdf
```

--------------------------------

### Install rlextra with pip

Source: https://docs.reportlab.com/install/ReportLab_Plus_version_installation/

Run this command in pip-win to install ReportLab PLUS and all associated packages from the private PyPi repository. The email address is used as the username for authentication.

```bash
pip install rlextra -i https://EMAIL:[[email protected]](https://docs.reportlab.com/cdn-cgi/l/email-protection)/pypi
```

--------------------------------

### PageCatcher makeforms example with test file

Source: https://docs.reportlab.com/pagecatcher/

Example command that extracts the first and third pages from 'picture.pdf', stores them with prefix 'pict', and creates a test PDF with a centimeter grid overlay.

```bash
pageCatcher makeforms picture.pdf -s pic.data -p pict --test pictest.pdf 0 2
```

--------------------------------

### Compact <lines> example with all coordinates on one line

Source: https://docs.reportlab.com/rml/userguide/Chapter_4_Basic_figures_lines_and_shapes/

Shows that coordinates can be arranged in any way, but keeping them on separate lines is more readable. This is the same as the previous example but written on a single line.

```RML
<lines>
    2.5in 10.5in 3.5in 10.5in 2.5in 10.25in 3.5in 10.25in 2.5in 10in 3.5in 10in
</lines>
```

--------------------------------

### Draw multiple lines with <lines>

Source: https://docs.reportlab.com/rml/userguide/Chapter_4_Basic_figures_lines_and_shapes/

Provide additional sets of four coordinates to draw separate lines. This example starts with the same line as the simple example and adds two more below it.

```RML
<lines>
    2.5in 10.5in 3.5in 10.5in
    2.5in 10.25in 3.5in 10.25in
    2.5in 10in 3.5in 10in
</lines>
```

--------------------------------

### Set Up Database with Django Migrate and Loaddata

Source: https://docs.reportlab.com/rml/tutorials/fund-reports/

Run these commands inside the /project/ directory to create the SQLite database and load initial data from the fixture. A superuser account will be created when prompted.

```bash
%   python manage.py migrate
%   python manage.py loaddata  project/fundreport/fixtures/initial_data.json
```

--------------------------------

### Install ReportLab with renderpm extension

Source: https://docs.reportlab.com/install/open_source_installation/

Installs the optional renderpm extension for speeding up reportlab.graphics.renderPM functions and bitmap image creation. Requires ReportLab 4.0.4 or later.

```bash
pip install "reportlab[renderpm]"
```

--------------------------------

### h2 tag usage example

Source: https://docs.reportlab.com/tagref/tag_h2/

Minimal example showing the h2 tag inside a story element. The surrounding document setup is omitted; see the RML samples for full document construction.

```xml
...
<story>
    <h2>Example text</h2>
</story>
...
```

--------------------------------

### Directory structure of tutorial pack

Source: https://docs.reportlab.com/rml/tutorials/product-catalogue/

Shows the layout of the tutorial pack: data/, output/, rml/, and product_catalog.py.

```text
data/ 
output/
rml/
product_catalog.py
```

--------------------------------

### Install rlextra with pip from ReportLab PyPi

Source: https://docs.reportlab.com/install/ReportLab_Plus_version_installation/

Manual installation command for ReportLab PLUS. Run this in a terminal on Linux, OSX, or similar systems. You will be prompted for your reportlab.com email address and password. Ensure pip is updated before running.

```bash
pip install rlextra -i https://www.reportlab.com/pypi/

Downloading/unpacking rlextra
User for www.reportlab.com: [email protected]
Password: your password
  Downloading rlextra-3.1.9.tar.gz (8.4MB): 7.9MB downloaded
  ...etc...
```

--------------------------------

### drawRightString example usage

Source: https://docs.reportlab.com/tagref/tag_drawrightstring/

Example of using the drawRightString tag inside a pageGraphics block to draw right-aligned text at specified coordinates. Only relevant sections are shown; full document setup requires additional tags.

```xml
<pageGraphics>
    <drawRightString x="297.5" y="800">This is a drawRightString example</drawRightString>
</pageGraphics>
```

--------------------------------

### Line and PolyLine examples

Source: https://docs.reportlab.com/reportlab/userguide/ch11_graphics/

Examples of creating Line and PolyLine shapes with various stroke properties, including color, width, and dash patterns.

```python
Line(50,50, 300,100,
 strokeColor=colors.blue, strokeWidth=5)
Line(50,100, 300,50,
 strokeColor=colors.red,
 strokeWidth=10,
 strokeDashArray=[10, 20])
PolyLine([120,110, 130,150, 140,110, 150,150, 160,110, 170,150, 180,110, 190,150, 200,110], strokeWidth=2, strokeColor=colors.purple)
```

--------------------------------

### PageCatcher 4page command example

Source: https://docs.reportlab.com/pagecatcher/

Example command that runs the 4page utility on c4611_sample_explain.pdf, placing four pages into one.

```bash
pagecatcher 4page c4611_sample_explain.pdf
```

--------------------------------

### drawCenteredString example in pageGraphics

Source: https://docs.reportlab.com/tagref/tag_drawcenteredstring/

Example usage of the <drawCenteredString> tag inside a <pageGraphics> block, drawing centered text at x=297.5 and y=800. Only relevant sections are shown; full document setup requires additional tags.

```xml
<pageGraphics>
    <drawCenteredString x="297.5" y="800">This is a drawCenteredString example</drawCenteredString>
</pageGraphics>
```

--------------------------------

### VerticalBarChart Example

Source: https://docs.reportlab.com/reportlab/userguide/ch11_graphics/

Example code demonstrating how to create a VerticalBarChart, set its data, axes, and labels, and add it to a drawing.

```APIDOC
## VerticalBarChart Example

### Description
Creates a vertical bar chart with two series of data, custom axes, and rotated category labels.

### Code
```python
from reportlab.graphics.shapes import Drawing
from reportlab.graphics.charts.barcharts import VerticalBarChart
from reportlab.lib import colors

drawing = Drawing(400, 200)

data = [
    (13, 5, 20, 22, 37, 45, 19, 4),
    (14, 6, 21, 23, 38, 46, 20, 5)
    ]

bc = VerticalBarChart()
bc.x = 50
bc.y = 50
bc.height = 125
bc.width = 300
bc.data = data
bc.strokeColor = colors.black

bc.valueAxis.valueMin = 0
bc.valueAxis.valueMax = 50
bc.valueAxis.valueStep = 10

bc.categoryAxis.labels.boxAnchor = 'ne'
bc.categoryAxis.labels.dx = 8
bc.categoryAxis.labels.dy = -2
bc.categoryAxis.labels.angle = 30
bc.categoryAxis.categoryNames = ['Jan-99','Feb-99','Mar-99',
   'Apr-99','May-99','Jun-99','Jul-99','Aug-99']

drawing.add(bc)
```

```

--------------------------------

### Install ReportLab with accel extension

Source: https://docs.reportlab.com/install/open_source_installation/

Installs the optional accel extension for C acceleration, mainly for string length calculations. Requires ReportLab 4.0.4 or later.

```bash
pip install "reportlab[accel]"
```

--------------------------------

### RML example: <td> table cell in blockTable

Source: https://docs.reportlab.com/tagref/tag_td/

Minimal example of a table cell using the <td> tag inside a <blockTable> and <tr>. Only relevant sections are shown; full document setup requires additional tags.

```xml
<blockTable>
    <tr>
        <td>This is a table cell</td>
    </tr>
</blockTable>
```

--------------------------------

### Example usage of the 'a' tag in RML

Source: https://docs.reportlab.com/tagref/tag_a/

Shows how to create a hyperlink using the 'a' tag with an href attribute inside a para element within a story. The example is a minimal snippet; full document setup requires additional tags as noted in the source.

```xml
<story>
    <para>
        <a href="https://docs.reportlab.com/">url</a>
    </para>
</story>
```

--------------------------------

### Tutorial pack directory structure

Source: https://docs.reportlab.com/rml/tutorials/fund-reports-json-to-pdf/

Shows the directory layout of the tutorial pack: data/, output/, rml/, and gen_factsheet.py.

```text
data/ 
output/
rml/
gen_factsheet.py
```

--------------------------------

### Example usage of <b> tag in RML

Source: https://docs.reportlab.com/tagref/tag_b/

Shows a minimal RML snippet with a <story> containing a <para> that uses the <b> tag to bolden 'Example Bold Text'. Note that only relevant sections are included; full document setup requires additional tags.

```XML
<story>
    <para>
        <b>Example Bold Text</b>
    </para>
</story>
```

--------------------------------

### RML table with images and padding (Example 18)

Source: https://docs.reportlab.com/rml/userguide/Chapter_13_Using_tables/

This snippet is incomplete in the source; it starts with the XML declaration and document element, then defines a blockTableStyle with alternating row backgrounds, blockAlignment, blockValign, and blockFont. The rest of the example (including the table with images and padding) is not shown in the provided text.

```RML
<?xml version="1.0" encoding="iso-8859-1" standalone="no" ?>
<!DOCTYPE document SYSTEM "rml.dtd">
<document filename="example_18.pdf">
    <template>
        <pageTemplate id="main">
            <pageGraphics>
            </pageGraphics>
            <frame id="first" x1="72" y1="72" width="451" height="698"/>
        </pageTemplate>
    </template>
    <stylesheet>
        <blockTableStyle id="myBlockTableStyle">
            <blockBackground colorName="silver" start="0,0" stop="-1,0"/>
            <blockBackground colorName="darkslategray" start="0,1" stop="-1,1"/>
            <blockBackground colorName="silver" start="0,2" stop="-1,2"/>
            <blockBackground colorName="darkslategray" start="0,3" stop="-1,3"/>
            <blockBackground colorName="silver" start="0,4" stop="-1,4"/>
            <blockBackground colorName="darkslategray" start="0,5" stop="-1,5"/>
            <blockAlignment value="CENTER"/>
            <blockValign value="MIDDLE"/>

            <!-- Set fonts -->
            <blockFont name="Helvetica-BoldOblique" size="10"/>

```

--------------------------------

### RML <curves> tag example

Source: https://docs.reportlab.com/rml/userguide/Chapter_10_More_graphics/

Example of using the <curves> tag inside <pageGraphics> to draw a Bézier curve. The tag requires 4 control points (8 numbers) as X-Y coordinate pairs. The curve starts at the first point and ends at the fourth, with tangents defined by the intermediate points.

```xml
<template>
  <pageTemplate id="main">
    <pageGraphics>
      <curves>
        198 560
        198 280
        396 280
        396 560
      </curves>
    </pageGraphics>
    <frame id="first" x1="0.5in" y1="0.5in" width="20cm" height="28cm"/>
  </pageTemplate>
</template>
```

--------------------------------

### Template definition and get() call

Source: https://docs.reportlab.com/preppy/

Shows the template definition syntax and the corresponding call to get() with positional arguments. The return value is always an 8-bit string (bytes in Python 3.x).

```preppy
{{def(name, sex)}}
```

```python
output = mymodule.get(name, sex)
```

--------------------------------

### Example usage of crossMark in an illustration

Source: https://docs.reportlab.com/tagref/tag_crossmark/

Shows how to use the crossMark tag inside an illustration tag within a story. The example includes two crossMark elements with different positions, sizes, colors, and widths. Note that only relevant sections are shown; full document setup requires additional tags.

```xml
<story>
    <illustration height="24" width="525" borderStrokeColor="red" borderStrokeWidth="0.5">
        <crossMark x="0" y="0" size="5" gap="1" color="green" width="1.5"/>
        <crossMark x="500" y="12" size="10" gap="1" color="blue" width="1"/>
    </illustration>
</story>
```

--------------------------------

### Python: rml2pdf.go() with in-memory output (Django example)

Source: https://docs.reportlab.com/rml/userguide/Chapter_1_Introduction/

Example of using rml2pdf.go() in a Django view to generate a PDF in memory and return it as an HTTP response.

```APIDOC
## Python: rml2pdf.go() with in-memory output (Django example)

### Description
Example of using rml2pdf.go() in a Django view to generate a PDF in memory and return it as an HTTP response.

### Method
Function Call

### Endpoint
`rml2pdf.go(rml, outputFileName=buf)`

### Parameters
#### Required Parameters
- **xmlInputText** (string) - Required - The RML specification for the PDF document to be generated.

#### Optional Parameters
- **outputFileName** (file-like object) - Optional - A file-like object (e.g., BytesIO) to write the PDF data to.

### Request Example
```python
from django.http import HttpResponse
from rlextra.rml2pdf import rml2pdf
import io

def getPDF(request):
    """Returns PDF as a binary stream."""

    # Use your favourite templating language here to create the RML string.
    # The generated document might depend on the web request parameters,
    # database lookups and so on - we'll leave that up to you.
    rml = getRML(request)

    buf = io.BytesIO()

    rml2pdf.go(rml, outputFileName=buf)
    pdfData = buf.getvalue()

    response = HttpResponse(content=pdfData, content_type='application/pdf')
    response['Content-Disposition'] = 'attachment; filename=output.pdf'
    return response
```

### Response
#### Success Response
- The function returns None. The PDF data is written to the provided file-like object.

#### Response Example
No response body; the output is a PDF file.
```

--------------------------------

### Create a TableStyle with a command sequence

Source: https://docs.reportlab.com/reportlab/userguide/ch7_tables/

Initializes a TableStyle with a list of commands. The example sets line styles, alignment, and colors for a table.

```python
LIST_STYLE = TableStyle(
    [('LINEABOVE', (0,0), (-1,0), 2, colors.green),
    ('LINEABOVE', (0,1), (-1,-1), 0.25, colors.black),
    ('LINEBELOW', (0,-1), (-1,-1), 2, colors.green),
    ('ALIGN', (1,1), (-1,-1), 'RIGHT')]
    )
```

--------------------------------

### textBox usage example in RML

Source: https://docs.reportlab.com/tagref/tag_textbox/

Example of using the textBox tag inside an illustration within a story. The snippet shows required attributes x, y, boxWidth, and boxHeight, with text content 'Filling in a text box'. Note that only relevant sections are shown; full document setup requires additional tags.

```xml
<story>
    <illustration width="8cm" height="5cm">
        <textBox x="1cm" y="-4cm" boxWidth="15cm" boxHeight="1cm">Filling in a text box</textBox>
    </illustration>
</story>
```

--------------------------------

### blockTable example usage

Source: https://docs.reportlab.com/tagref/tag_blocktable/

Minimal example showing a blockTable with a style attribute and two rows of table cells. Only relevant sections are shown; other tags are omitted for brevity.

```xml
<story>
    <blockTable style="table1">
        <tr><td>Table style example</td></tr>
        <tr><td>Table style example</td></tr>
    </blockTable>
</story>
```

--------------------------------

### barCodeFlowable usage example

Source: https://docs.reportlab.com/tagref/tag_barcodeflowable/

Insert a barcode flowable into a story. The example uses code="EAN8", barWidth="3", barHeight="50", and value="00000000". Only relevant sections are shown; full document setup requires additional tags.

```xml
<story>
    <barCodeFlowable code="EAN8" barWidth="3" barHeight="50" value="00000000"/>
</story>
```

--------------------------------

### textField tag example in RML template

Source: https://docs.reportlab.com/tagref/tag_textfield/

Example of using the textField tag inside a pageTemplate's pageGraphics section. The snippet shows a minimal template with a textField named 'text' at position (150, 750) with a value and tooltip. Only relevant sections are included; full document setup requires additional tags.

```xml
<template>
    <pageTemplate id="Page" pageSize="(595, 842)">
        <pageGraphics>
            <textField name="text" x="150" y="750" value="Test" tooltip="tooltip text"/>
        </pageGraphics>
        <frame id="Frame 1" x1="30" y1="30" width="535" height="782" showBoundary="1"/>
    </pageTemplate>
</template>
```

--------------------------------

### Example usage of checkBox tag in RML

Source: https://docs.reportlab.com/tagref/tag_checkbox/

Creates a checkbox at specified coordinates within an illustration. The example shows a minimal story structure with an illustration of width 8cm and height 5cm, containing a checkBox at x=1cm and y=-2cm. Note that only relevant sections are included; full document setup requires additional tags.

```xml
<story>
    <illustration width="8cm" height="5cm">
        <checkBox x="1cm" y="-2cm"/>
    </illustration>
</story>
```

--------------------------------

### Example usage of case_b in a dynamic RML document

Source: https://docs.reportlab.com/tagref/tag_case_b/

Shows how to use case_b within a switch_b tag to handle different conditions. The example includes a document with a story containing an assign_b tag to set a variable, and a switch_b with multiple case_b tags and a default_b. Only relevant sections are shown; full document setup may require additional tags.

```xml
<!DOCTYPE document SYSTEM "../dynamic_rml.dtd">
<document filename="main.pdf">
    ...
    <story>
        <assign_b name="test" value="2"/>
        <switch_b expr="test">
            <case_b condition="1"><para>ex 1</para></case_b>
            <case_b condition="2"><para>ex 2</para></case_b>
            <case_b condition="3"><para>ex 3</para></case_b>
            <default_b><para>Example</para></default_b>
        </switch_b>
    </story>
</document>
```

--------------------------------

### Execute rml2pdf and get output PDF filename

Source: https://docs.reportlab.com/webintegration/Integrating_ReportLab_into_your_website/

Starts the Python process with the constructed command line, and reads the output filename from StandardOutput.ReadLine(). The rml2pdf module creates the PDF in the current working directory.

```vbnet
pythonProcess = New Process()
pythonProcess.StartInfo = pythonPSI
pythonProcess.Start()

Dim outputPDF As String = System.IO.Path.GetTempPath & pythonProcess.StandardOutput.ReadLine()
```

--------------------------------

### atStart method - Cleaner class

Source: https://docs.reportlab.com/radxml/

Returns True if the buffer is empty, indicating the cleaner is at the start of the content.

```python
def atStart(self):
    return (len(self.buf) == 0)
```

--------------------------------

### Example usage of pageGraphics in a pageTemplate

Source: https://docs.reportlab.com/tagref/tag_pagegraphics/

Shows a minimal RML template with a pageGraphics block containing a drawRightString element. The snippet is partial; full document setup requires additional tags as noted in the source.

```xml
<template>
    <pageTemplate id="Page 1" pageSize="(595, 842)">
        <pageGraphics>
            <drawRightString x="565" y="800">This is page <pageNumber/></drawRightString>
        </pageGraphics>
        <frame id="Frame 1" x1="30" y1="30" width="535" height="782"/>
    </pageTemplate>
</template>
```

--------------------------------

### RML example for blockLeftPadding tag

Source: https://docs.reportlab.com/tagref/tag_blockleftpadding/

Shows a minimal RML snippet with a blockTableStyle using blockLeftPadding to set left padding for a table block. Only relevant sections are included; full document setup requires additional tags.

```xml
<stylesheet>
    <blockTableStyle id="table1" spaceAfter="0.5 cm">
        <blockLeftPadding length="10" start="0,0" stop="-1,-1"/>
    </blockTableStyle>
</stylesheet>
<story>
    <blockTable style="table1">
        <tr><td>Table style example</td></tr>
        <tr><td>Table style example</td></tr>
    </blockTable>
</story>
```

--------------------------------

### RML example: Using <br> to create a line break

Source: https://docs.reportlab.com/tagref/tag_br/

Shows a minimal RML story with a <para> containing two lines separated by <br/>. The tag starts a new line with the current line spacing, not a paragraph gap.

```xml
<story>
    <para>Line 1<br/>Line 2</para>
</story>
```

--------------------------------

### Table with Line Commands and Splitting Example

Source: https://docs.reportlab.com/reportlab/userguide/ch7_tables/

Shows a table with multiple line commands and background colors, used to illustrate problems when tables split. Includes GRID, BOX, LINEABOVE, LINEBEFORE, and BACKGROUND commands.

```python
    data=  [['00', '01', '02', '03', '04'],
            ['10', '11', '12', '13', '14'],
            ['20', '21', '22', '23', '24'],
            ['30', '31', '32', '33', '34']]
    t=Table(data,style=[
                    ('GRID',(0,0),(-1,-1),0.5,colors.grey),
                    ('GRID',(1,1),(-2,-2),1,colors.green),
                    ('BOX',(0,0),(1,-1),2,colors.red),
                    ('BOX',(0,0),(-1,-1),2,colors.black),
                    ('LINEABOVE',(1,2),(-2,2),1,colors.blue),
                    ('LINEBEFORE',(2,1),(2,-2),1,colors.pink),
                    ('BACKGROUND', (0, 0), (0, 1), colors.pink),
                    ('BACKGROUND', (1, 1), (1, 2), colors.lavender),
                    ('BACKGROUND', (2, 2), (2, 3), colors.orange),
                    ])
```

--------------------------------

### Basic <p> tag usage in RML story

Source: https://docs.reportlab.com/tagref/tag_p/

Declares a paragraph of text using the <p> tag inside a <story> element. This is the minimal example; full document setup requires additional tags as shown in the ReportLab samples.

```xml
<story>
    <p>My Text</p>
</story>
```

--------------------------------

### Example usage of <curvesto> in a path

Source: https://docs.reportlab.com/tagref/tag_curvesto/

Shows a <pageGraphics> block with a <path> element containing multiple <curvesto> tags to define a bezier curve. The snippet is truncated to relevant sections; full document setup is available in linked samples.

```xml
<pageGraphics>
    <path x="0" y="89.93" close="yes" stroke="yes" clip="yes">
        <moveto>128.755 15.979</moveto>
        <curvesto>43.5303 37.2158 10.1621 71.8726 0 78.8896</curvesto>
        0 164.063
        <curvesto>40.6992 167.07 105.996 158.279 174.089 141.313</curvesto>
        <curvesto>237.792 125.438 281.841 105.292 319.089 83.2666</curvesto>
        319.089 3.646
        <curvesto>274.999 -2.29736 203.875 -2.73926 128.755 15.9795</curvesto>
    </path>
</pageGraphics>
```

--------------------------------

### Import preppy from rlextra (old)

Source: https://docs.reportlab.com/releases/notes/whats-new-27/

Old import style for preppy before it became an external dependency.

```python
from rlextra.preppy import preppy
```

--------------------------------

### Example usage of script_b tag in RML

Source: https://docs.reportlab.com/tagref/tag_script_b/

Shows how to use script_b tags to assign variables and use them in a paragraph with the expr tag. Requires the dynamic RML DTD. The snippet is partial; full document setup is shown in linked samples.

```xml
<!DOCTYPE document SYSTEM "../dynamic_rml.dtd">
<document filename='test_020_dynamic.pdf'>
    ...
    <story>
        <script_b>x = 3</script_b>
        <script_b>y = x + 2</script_b>
        <script_b>z = "Variable" + str(y)</script_b>
        <para><expr>z</expr></para>
    </story>
</document>
```

--------------------------------

### Set up ProcessStartInfo for Python executable

Source: https://docs.reportlab.com/webintegration/Integrating_ReportLab_into_your_website/

Initializes a ProcessStartInfo object to run the Python executable, which is required to execute the rml2pdf module from .NET.

```vbnet
Dim pythonProcess As Process
Dim pythonPSI As ProcessStartInfo
pythonPSI = New ProcessStartInfo("python")
```

--------------------------------

### loop_b example with range and expr

Source: https://docs.reportlab.com/tagref/tag_loop_b/

Shows a minimal RML document using loop_b to iterate over range(5) and insert the loop variable i into a paragraph via the expr tag. Only relevant sections are shown; the full document setup is omitted.

```xml
<!DOCTYPE document SYSTEM "../dynamic_rml.dtd">
<document filename='test_020_dynamic.pdf'>
    ...
    <story>
        <loop_b var="i" in="range(5)">
            <para>pass <expr>i</expr>: this adds dynamic capabilities</para>
        </loop_b>
    </story>
</document>
```

--------------------------------

### Include PDF pages in RML story

Source: https://docs.reportlab.com/tagref/tag_includepdfpages/

Example usage of the includePdfPages tag within a story element. The filename attribute is required, and leadingFrame is set to '0'. Only relevant sections are shown; full document setup requires additional tags.

```xml
...
<story>
    <includePdfPages filename="example.pdf" leadingFrame="0"/>
</story>
...
```

--------------------------------

### Example usage of docAssert with docAssign

Source: https://docs.reportlab.com/tagref/tag_docassert/

Shows a minimal RML story that assigns a variable i to 4 and asserts that i equals 4. The cond attribute is required and the format attribute is implied. Only relevant sections are shown; full document setup is not included.

```xml
<story>
    <docAssign var="i" expr="4"/>
    <docAssert cond="i==4"/>
</story>
```

--------------------------------

### Hello World Canvas Drawing Example

Source: https://docs.reportlab.com/reportlab/userguide/ch2_graphics/

Complete example of creating a PDF with ReportLab's canvas. It translates the origin, sets font and colors, draws lines and a rectangle, rotates the canvas, and draws a text string. The code creates a canvas, calls the 'hello' function, and saves the PDF.

```python
from reportlab.pdfgen import canvas
from reportlab.lib.units import inch

def hello(c):
    # move the origin up and to the left
    c.translate(inch,inch)
    # define a large font
    c.setFont("Helvetica", 14)
    # choose some colors
    c.setStrokeColorRGB(0.2,0.5,0.3)
    c.setFillColorRGB(1,0,1)
    # draw some lines
    c.line(0,0,0,1.7*inch)
    c.line(0,0,1*inch,0)
    # draw a rectangle
    c.rect(0.2*inch,0.2*inch,1*inch,1.5*inch, fill=1)
    # make text go straight up
    c.rotate(90)
    # change color
    c.setFillColorRGB(0,0,0.77)
    # say hello (note after rotate the y coord needs to be negative!)
    c.drawString(0.3*inch, -inch, "Hello World")
c = canvas.Canvas("hello.pdf")
hello(c)
c.showPage()
c.save()
```

--------------------------------

### setFontSize tag usage in RML template

Source: https://docs.reportlab.com/tagref/tag_setfontsize/

Example of using setFontSize within a pageGraphics block to set font size to 20 and draw a right-aligned string. The snippet shows only relevant sections; full document setup requires additional tags.

```xml
<template title="myPage" lang="en-GB" pageSize="(595, 842)" leftMargin="72" showBoundary="0">
    <pageTemplate id="body">
        <pageGraphics>
            <setFontSize size="20"/>
            <drawRightString x="518" y="808">Example text</drawRightString>
        </pageGraphics>
        <frame id="general" x1="30" y1="30" width="535" height="782"/>
    </pageTemplate>
</template>
```

--------------------------------

### Verify license by importing and checking attributes

Source: https://docs.reportlab.com/rml/licence-file-deployment-and-verification/

Example verification of the license by importing it, checking the file path, license number, user, and expiry date.

```python
$ python
Python 2.7.13 (default, Sep 26 2018, 18:42:22) 
[GCC 6.3.0 20170516] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> import ReportLabPLUSLicense
>>> ReportLabPLUSLicense.__file__
'ReportLabPLUSLicense.py'
>>>ReportLabPLUSLicense.number
'20200323095038'
>>> ReportLabPLUSLicense.user
'customer-{optional-comment}-year-issued'
>>>import time
>>>time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(ReportLabPLUSLicense.expire))
'2020-09-19 01:00:00'
```

--------------------------------

### Create a Pie Chart with ReportLab

Source: https://docs.reportlab.com/reportlab/userguide/ch11_graphics/

Example showing how to create a pie chart using the Pie class, set data and labels, and customize individual slices. The example sets the pie's position, size, data, labels, and slice properties such as stroke width, popout, and label radius.

```python
from reportlab.graphics.charts.piecharts import Pie
from reportlab.graphics.shapes import Drawing
from reportlab.lib import colors

d = Drawing(200, 100)

pc = Pie()
pc.x = 65
pc.y = 15
pc.width = 70
pc.height = 70
pc.data = [10,20,30,40,50,60]
pc.labels = ['a','b','c','d','e','f']

pc.slices.strokeWidth=0.5
pc.slices[3].popout = 10
pc.slices[3].strokeWidth = 2
pc.slices[3].strokeDashArray = [2,2]
pc.slices[3].labelRadius = 1.75
pc.slices[3].fontColor = colors.red
d.add(pc)
```

--------------------------------

### RML example: highlightAnnotation with pageTemplate and story

Source: https://docs.reportlab.com/tagref/tag_highlightannotation/

Shows a highlightAnnotation tag inside a pageTemplate's pageGraphics, with a placePara in the story. The annotation is clickable and displays the text 'Test'. Only relevant sections are shown; full document setup requires additional tags.

```xml
<template>
    <pageTemplate id="Page" pageSize="(595, 842)">
        <pageGraphics>
            <highlightAnnotation color="red" name="annotation 1" addToPage="1" rect="100,300, 300,350">
                Test
            </highlightAnnotation>
        </pageGraphics>
        <frame id="Frame 1" x1="30" y1="30" width="535" height="782" showBoundary="1"/>
    </pageTemplate>
</template>
...
<story>
    <placePara width="200" x="100" y="300">Test Text</placePara>
</story>
```

--------------------------------

### Run json2pdf with wsgi-serve

Source: https://docs.reportlab.com/json2pdf/

Starts the json2pdf web server using wsgi-serve.

```bash
$ wsgi-serve
```
Tokens:
Raw