# Base report xlsx

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

Table of contents

- Installation
- Usage
- Bug Tracker
- Credits
  - Authors
  - Contributors
  - Maintainers

## 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

- Adrien Peiffer <adrien.peiffer@acsone.eu>
- Sébastien Alix <sebastien.alix@osiell.com>
- Stéphane Bidoul <stephane.bidoul@acsone.eu>
- Enric Tobella <etobella@creublanca.es>
- Graeme Gellatly <gdgellatly@gmail.com>
- Cristian Salamea <cs@prisehub.com>
- Rod Schouteden <rod.schouteden@dynapps.be>
- Eugene Molotov <molotov@it-projects.info>
- Christopher Ormaza <chris.ormaza@forgeflow.com>
- Houzéfa Abbasbhay <houzefa.abba@xcg-consulting.fr>
- Le Dinh Tien <tien-ld@komit-consulting.com>

### Maintainers

This module is maintained by the OCA.

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.