Base report xlsx

Overview

Base XLSX report generation framework (OCA) using xlsxwriter. Other modules inherit from this to create custom Excel reports.

Key Features

• XLSX report type in Odoo
• Base abstract model for XLSX reports
• Report attachment saving
• xlsxwriter integration

Extends Existing Models

Documentation

.. image:: https://odoo-community.org/readme-banner-image

:target: https://odoo-community.org/get-involved?utm_source=readme

:alt: Odoo Community Association

Base report xlsx

..

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

!! This file is generated by oca-gen-addon-readme !!

!! changes will be overwritten. !!

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

!! source digest: sha256:61af5f70a44c329b90fa1b3c7e98e743299c3bb6c1d8c385563d620f18d835e9

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Mature-brightgreen.png

:target: https://odoo-community.org/page/development-status

:alt: Mature

.. |badge2| image:: https://img.shields.io/badge/license-AGPL--3-blue.png

:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html

:alt: License: AGPL-3

.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github

:target: https://github.com/OCA/reporting-engine/tree/19.0/report_xlsx

:alt: OCA/reporting-engine

.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png

:target: https://translation.odoo-community.org/projects/reporting-engine-19-0/reporting-engine-19-0-report_xlsx

:alt: Translate me on Weblate

.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png

:target: https://runboat.odoo-community.org/builds?repo=OCA/reporting-engine&target_branch=19.0

:alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

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

**Table of contents**

.. contents::

:local:

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 :

::

Print to XLSX

res.partner

xlsx

module_name.report_name

module_name.report_file

report

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

• Adrien Peiffer
• Sébastien Alix
• Stéphane Bidoul
• Enric Tobella
• Graeme Gellatly
• Cristian Salamea
• Rod Schouteden
• Eugene Molotov
• Christopher Ormaza
• Houzéfa Abbasbhay
• Le Dinh Tien

Maintainers

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png

:alt: Odoo Community Association

:target: https://odoo-community.org

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.