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 Runboat

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 :

<record id="action_report_partner_xlsx" model="ir.actions.report">
    <field name="name">Print to XLSX</field>
    <field name="model">res.partner</field>
    <field name="report_type">xlsx</field>
    <field name="report_name">module_name.report_name</field>
    <field name="report_file">module_name.report_file</field>
    <field name="binding_model_id" ref="res.partner"/>
    <field name="binding_type">report</field>
    <field name="attachment_use" eval="False"/>
</record>

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 to smash 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

File details

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

File metadata

File hashes

Hashes for odoo_addon_report_xlsx-18.0.1.0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ca37941d7845be9db1c9e891bb9258f07ca92cdf246fd4d8c3fd649d40b63120
MD5 b62af3c8b6c925841fca28e7b33c8f68
BLAKE2b-256 cd30e2d54aa9ffe1d6d391b180f7973e7100ffa56765832f23e8d5ccef26a613

See more details on using hashes here.

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