Skip to main content

Base module to create xlsx report

Project description

Odoo Community Association

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

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

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

odoo_addon_report_xlsx-19.0.1.0.2.2-py3-none-any.whl (47.7 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for odoo_addon_report_xlsx-19.0.1.0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 bb269e89d5cb5af13353c921a86e29d56ade37f63b2598fc2baf470c30d6c551
MD5 e87ee6fae8a4999a621d44ea677c8c63
BLAKE2b-256 4ae2f64bc4ad0e79d6a78f42a7313d4368f3246ec14d441cfc9293c890b9c5fe

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