Skip to main content

Base module to create xlsx report

Project description

License: AGPL-3

Base report xlsx

This module provides a basic report class to generate xlsx report.

Installation

Make sure you have xlsxwriter Python module installed:

$ pip install xlsxwriter

Usage

An example of XLSX report for partners:

A python class

from odoo.addons.report_xlsx.report.report_xlsx import ReportXlsx

class PartnerXlsx(ReportXlsx):

    def generate_xlsx_report(self, workbook, data, partners):
        for obj in partners:
            report_name = obj.name
            # One sheet by partner
            sheet = workbook.add_worksheet(report_name[:31])
            bold = workbook.add_format({'bold': True})
            sheet.write(0, 0, obj.name, bold)


PartnerXlsx('report.res.partner.xlsx',
            'res.partner')

To manipulate the workbook and sheet objects, refer to the documentation of xlsxwriter.

A report XML record

<report
    id="partner_xlsx"
    model="res.partner"
    string="Print to XLSX"
    report_type="xlsx"
    name="res.partner.xlsx"
    file="res.partner.xlsx"
    attachment_use="False"
/>

XLSX Header & Footer

You can configure them on the menu Settings > Technical > Reports > XLSX Header/Footer following the syntax from xlsxwriter documentation.

Example of Header / Footer syntax : &LPage &P of &N &CFilename: &F &RSheetname: &A

On a report XML with report_type == 'xlsx' you can specified the Header and Footer you configured.

Try me on Runbot

Bug Tracker

Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us smashing it by providing a detailed and welcomed feedback.

Credits

Contributors

Maintainer

Odoo Community Association

This module is maintained by the OCA.

OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.

To contribute to this module, please visit https://odoo-community.org.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page