Skip to main content

Base module to create xlsx report

Project description

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

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

Table of contents

Installation

Make sure you have xlsxwriter Python module installed:

$ pip3 install xlsxwriter

For testing it is also necessary xlrd Python module installed:

$ pip3 install xlrd

Usage

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"
/>

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.

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

Credits

Authors

  • ACSONE SA/NV

  • Creu Blanca

Contributors

Maintainers

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.

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

If you're not sure about the file name format, learn more about wheel file names.

odoo_addon_report_xlsx-15.0.1.1.2-py3-none-any.whl (46.5 kB view details)

Uploaded Python 3

File details

Details for the file odoo_addon_report_xlsx-15.0.1.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for odoo_addon_report_xlsx-15.0.1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e36bcf9c81752600c80d0489989ccd3ffb801129d31d9aa8a815a50f7f3b9456
MD5 2d9feec9cfdfb781d2f70181e5e09a38
BLAKE2b-256 b53800e8f813cf37802c64d5e60428c1eef20c138b9d05c7f252494020299e19

See more details on using hashes here.

Supported by

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