Skip to content

Latest commit

 

History

History
133 lines (99 loc) · 4.41 KB

README.rst

File metadata and controls

133 lines (99 loc) · 4.41 KB

Base report xlsx

Mature License: AGPL-3 OCA/reporting-engine Translate me on Weblate Try me on Runboat

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

Table of contents

Make sure you have xlsxwriter Python module installed:

$ pip3 install xlsxwriter

For testing it is also necessary xlrd Python module installed:

$ pip3 install xlrd

An example of XLSX report for partners on a module called module_name:

A python class

from odoo import models

class PartnerXlsx(models.AbstractModel):
    _name = 'report.module_name.report_name'
    _inherit = 'report.report_xlsx.abstract'

    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)

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="module_name.report_name"
    file="res_partner"
    attachment_use="False"
/>

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 to smash it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.

  • ACSONE SA/NV
  • Creu Blanca

This module is maintained by the OCA.

Odoo Community Association

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.

This module is part of the OCA/reporting-engine project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.