From df6b913cfb91db70e3bf304667027bca246ed770 Mon Sep 17 00:00:00 2001 From: "Pedro M. Baeza" Date: Fri, 21 Dec 2018 10:12:14 +0100 Subject: [PATCH] [IMP] report_xlsx: README by fragments --- report_xlsx/README.rst | 75 +++- report_xlsx/readme/CONTRIBUTORS.rst | 6 + report_xlsx/readme/DESCRIPTION.rst | 1 + report_xlsx/readme/INSTALL.rst | 7 + report_xlsx/readme/USAGE.rst | 32 ++ report_xlsx/static/description/index.html | 472 ++++++++++++++++++++++ 6 files changed, 573 insertions(+), 20 deletions(-) create mode 100644 report_xlsx/readme/CONTRIBUTORS.rst create mode 100644 report_xlsx/readme/DESCRIPTION.rst create mode 100644 report_xlsx/readme/INSTALL.rst create mode 100644 report_xlsx/readme/USAGE.rst create mode 100644 report_xlsx/static/description/index.html diff --git a/report_xlsx/README.rst b/report_xlsx/README.rst index 5e33e5be..b8a04eb2 100644 --- a/report_xlsx/README.rst +++ b/report_xlsx/README.rst @@ -1,23 +1,47 @@ -.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg - :target: https://www.gnu.org/licenses/agpl-3.0-standalone.html - :alt: License: AGPL-3 - ================ Base report xlsx ================ +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png + :target: https://odoo-community.org/page/development-status + :alt: Beta +.. |badge2| image:: https://img.shields.io/badge/licence-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/12.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-12-0/reporting-engine-12-0-report_xlsx + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/143/12.0 + :alt: Try me on Runbot + +|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:: -$ pip install xlsxwriter +$ pip3 install xlsxwriter For testing it is also necessary ``xlrd`` Python module installed:: -$ pip install xlrd +$ pip3 install xlrd Usage ===== @@ -55,37 +79,48 @@ A report XML record :: attachment_use="False" /> -.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas - :alt: Try me on Runbot - :target: https://runbot.odoo-community.org/runbot/143/12.0 - 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 smashing it by providing a detailed and welcomed feedback. +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 smashing 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 -Maintainer ----------- +Maintainers +~~~~~~~~~~~ + +This module is maintained by the OCA. .. image:: https://odoo-community.org/logo.png :alt: Odoo Community Association :target: https://odoo-community.org -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. -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. -To contribute to this module, please visit https://odoo-community.org. +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/report_xlsx/readme/CONTRIBUTORS.rst b/report_xlsx/readme/CONTRIBUTORS.rst new file mode 100644 index 00000000..f289ee23 --- /dev/null +++ b/report_xlsx/readme/CONTRIBUTORS.rst @@ -0,0 +1,6 @@ +* Adrien Peiffer +* Sébastien Alix +* Stéphane Bidoul +* Enric Tobella +* Graeme Gellatly +* Cristian Salamea diff --git a/report_xlsx/readme/DESCRIPTION.rst b/report_xlsx/readme/DESCRIPTION.rst new file mode 100644 index 00000000..894b1246 --- /dev/null +++ b/report_xlsx/readme/DESCRIPTION.rst @@ -0,0 +1 @@ +This module provides a basic report class to generate xlsx report. diff --git a/report_xlsx/readme/INSTALL.rst b/report_xlsx/readme/INSTALL.rst new file mode 100644 index 00000000..f75fbf25 --- /dev/null +++ b/report_xlsx/readme/INSTALL.rst @@ -0,0 +1,7 @@ +Make sure you have ``xlsxwriter`` Python module installed:: + +$ pip3 install xlsxwriter + +For testing it is also necessary ``xlrd`` Python module installed:: + +$ pip3 install xlrd diff --git a/report_xlsx/readme/USAGE.rst b/report_xlsx/readme/USAGE.rst new file mode 100644 index 00000000..75103856 --- /dev/null +++ b/report_xlsx/readme/USAGE.rst @@ -0,0 +1,32 @@ +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 :: + + diff --git a/report_xlsx/static/description/index.html b/report_xlsx/static/description/index.html new file mode 100644 index 00000000..d12ef114 --- /dev/null +++ b/report_xlsx/static/description/index.html @@ -0,0 +1,472 @@ + + + + + + +Base report xlsx + + + +
+

Base report xlsx

+ + +

Beta License: AGPL-3 OCA/reporting-engine Translate me on Weblate Try me on Runbot

+

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

+
+<report
+    id="partner_xlsx"
+    model="res.partner"
+    string="Print to XLSX"
+    report_type="xlsx"
+    name="module_name.report_name"
+    file="res_partner"
+    attachment_use="False"
+/>
+
+
+
+

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 smashing 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.

+
+
+
+ +