.. 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:0deaf9bb3813b310c567dc4a46f38c64345f7d2ec03dc35e8d3a5f6f97e127ab
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |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/18.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-18-0/reporting-engine-18-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=18.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 <http://xlsxwriter.readthedocs.org/>`__ 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 <https://github.com/OCA/reporting-engine/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 <https://github.com/OCA/reporting-engine/issues/new?body=module:%20report_xlsx%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

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.

.. 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 <https://github.com/OCA/reporting-engine/tree/18.0/report_xlsx>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
