diff --git a/README.md b/README.md index eaca6ae67..a29283512 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,7 @@ addon | version | maintainers | summary [report_substitute](report_substitute/) | 13.0.1.0.0 | [![sbejaoui](https://github.com/sbejaoui.png?size=30px)](https://github.com/sbejaoui) | This module allows to create substitution rules for report actions. [report_wkhtmltopdf_param](report_wkhtmltopdf_param/) | 13.0.1.0.0 | | Add new parameters for a paper format to be used by wkhtmltopdf command as arguments. [report_xlsx](report_xlsx/) | 13.0.1.1.1 | | Base module to create xlsx report +[report_xlsx_boilerplate](report_xlsx_boilerplate/) | 13.0.1.0.0 | | Module extending Base Report XLSX to add Boilerplate on XLSX reports. [report_xlsx_helper](report_xlsx_helper/) | 13.0.1.1.3 | | Report xlsx helpers [report_xml](report_xml/) | 13.0.1.1.1 | | Allow to generate XML reports diff --git a/report_xlsx_boilerplate/README.rst b/report_xlsx_boilerplate/README.rst new file mode 100644 index 000000000..ae2aa388d --- /dev/null +++ b/report_xlsx_boilerplate/README.rst @@ -0,0 +1,103 @@ +============================ +Base Report XLSX Boilerplate +============================ + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:061058428118c6409f05da0b355c1b07f3289a625be28d62522c680e878e76f4 + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |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/13.0/report_xlsx_boilerplate + :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-13-0/reporting-engine-13-0-report_xlsx_boilerplate + :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=13.0 + :alt: Try me on Runboat + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This addon provides the possibility to add a Boilerplate Template from which then you +can add changes on top of that. It can be useful for those reports that require to +always have a pre-defined structure and then some extra information starting from the +template. + +**Table of contents** + +.. contents:: + :local: + +Installation +============ + +This module requires to have the ``openpyxl`` Python module installed. + +Usage +===== + +An example of XLSX report which has a Boilerplate within the module called `module_name`: + +A python class :: + + from odoo import models + + class ReportBoilerplateXlsx(models.AbstractModel): + _name = "report.module_name.report_name" + _description = "Report Boilerplate" + _inherit = "report.report_xlsx.abstract" + + _boilerplate_template_file_path = "report/boilerplate_templates/report.xlsx" + +**IMPORTANT** +The XLSX Boilerplate file needs to be located inside a folder within the module directory. + +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 +~~~~~~~ + +* ForgeFlow + +Contributors +~~~~~~~~~~~~ + +* Guillem Casassas + +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. diff --git a/report_xlsx_boilerplate/static/description/icon.png b/report_xlsx_boilerplate/static/description/icon.png new file mode 100644 index 000000000..3a0328b51 Binary files /dev/null and b/report_xlsx_boilerplate/static/description/icon.png differ diff --git a/report_xlsx_boilerplate/static/description/index.html b/report_xlsx_boilerplate/static/description/index.html new file mode 100644 index 000000000..018384570 --- /dev/null +++ b/report_xlsx_boilerplate/static/description/index.html @@ -0,0 +1,447 @@ + + + + + + +Base Report XLSX Boilerplate + + + +
+

Base Report XLSX Boilerplate

+ + +

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

+

This addon provides the possibility to add a Boilerplate Template from which then you +can add changes on top of that. It can be useful for those reports that require to +always have a pre-defined structure and then some extra information starting from the +template.

+

Table of contents

+ +
+

Installation

+

This module requires to have the openpyxl Python module installed.

+
+
+

Usage

+

An example of XLSX report which has a Boilerplate within the module called module_name:

+

A python class

+
+from odoo import models
+
+class ReportBoilerplateXlsx(models.AbstractModel):
+    _name = "report.module_name.report_name"
+    _description = "Report Boilerplate"
+    _inherit = "report.report_xlsx.abstract"
+
+    _boilerplate_template_file_path = "report/boilerplate_templates/report.xlsx"
+
+

IMPORTANT +The XLSX Boilerplate file needs to be located inside a folder within the module directory.

+
+
+

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

+
    +
  • ForgeFlow
    • +
+
+
+

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.

+
+
+
+ + diff --git a/setup/_metapackage/VERSION.txt b/setup/_metapackage/VERSION.txt index 70427e18a..8fb2842ad 100644 --- a/setup/_metapackage/VERSION.txt +++ b/setup/_metapackage/VERSION.txt @@ -1 +1 @@ -13.0.20221001.1 \ No newline at end of file +13.0.20231016.0 \ No newline at end of file diff --git a/setup/_metapackage/setup.py b/setup/_metapackage/setup.py index 618895994..1319c9be6 100644 --- a/setup/_metapackage/setup.py +++ b/setup/_metapackage/setup.py @@ -29,6 +29,7 @@ setuptools.setup( 'odoo13-addon-report_substitute', 'odoo13-addon-report_wkhtmltopdf_param', 'odoo13-addon-report_xlsx', + 'odoo13-addon-report_xlsx_boilerplate', 'odoo13-addon-report_xlsx_helper', 'odoo13-addon-report_xml', ],