===============
Base report csv
===============
..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:01b8fdc19f619ac8936ee24eef041aad897ed02b920e3dfc3c83df98bd920c06
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |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/14.0/report_csv
: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-14-0/reporting-engine-14-0-report_csv
: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=14.0
:alt: Try me on Runboat
|badge1| |badge2| |badge3| |badge4| |badge5|
This module provides a basic report class to generate csv report.
**Table of contents**
.. contents::
:local:
Configuration
=============
In case the exported CSV report should be encoded in another system than UTF-8, following
fields of the report record (*Settings > Technical > Reports*) should be populated accordingly.
* Encoding: set an encoding system (such as cp932)
* Encode Error Handling: select 'Ignore' or 'Replace' as necessary.
* 'Ignore': in case of an encoding error, the problematic character will be removed from the exported file.
* 'Replace': in case of an encoding error, the problematic character will be replaced with '?' symbol.
* Leaving the field blank: in case of an encoding error, the report generation fails with an error message.
Usage
=====
An example of CSV report for partners on a module called `module_name`:
A python class ::
from odoo import models
class PartnerCSV(models.AbstractModel):
_name = 'report.report_csv.partner_csv'
_inherit = 'report.report_csv.abstract'
def generate_csv_report(self, writer, data, partners):
writer.writeheader()
for obj in partners:
writer.writerow({
'name': obj.name,
'email': obj.email,
})
def csv_report_options(self):
res = super().csv_report_options()
res['fieldnames'].append('name')
res['fieldnames'].append('email')
res['delimiter'] = ';'
res['quoting'] = csv.QUOTE_ALL
return res
A report XML record ::
<report
id="partner_csv"
model="res.partner"
string="Print to CSV"
report_type="csv"
name="module_name.report_name"
file="res_partner"
attachment_use="False"
/>
Update encoding with an appropriate value (e.g. cp932) as necessary.
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_csv%0Aversion:%2014.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
~~~~~~~
* Creu Blanca
Contributors
~~~~~~~~~~~~
* Enric Tobella <etobella@creublanca.es>
* Jaime Arroyo <jaime.arroyo@creublanca.es>
* Rattapong Chokmasermkul <rattapongc@ecosoft.co.th>
* `Quartile <https://www.quartile.co>`__:
* Aung Ko Ko Lin
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/14.0/report_csv>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
Raw data
{
"_id": null,
"home_page": "https://github.com/OCA/reporting-engine",
"name": "odoo14-addon-report-csv",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Creu Blanca, Odoo Community Association (OCA)",
"author_email": "support@odoo-community.org",
"download_url": null,
"platform": null,
"description": "===============\nBase report csv\n===============\n\n.. \n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n !! This file is generated by oca-gen-addon-readme !!\n !! changes will be overwritten. !!\n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n !! source digest: sha256:01b8fdc19f619ac8936ee24eef041aad897ed02b920e3dfc3c83df98bd920c06\n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n\n.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png\n :target: https://odoo-community.org/page/development-status\n :alt: Beta\n.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png\n :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html\n :alt: License: AGPL-3\n.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github\n :target: https://github.com/OCA/reporting-engine/tree/14.0/report_csv\n :alt: OCA/reporting-engine\n.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png\n :target: https://translation.odoo-community.org/projects/reporting-engine-14-0/reporting-engine-14-0-report_csv\n :alt: Translate me on Weblate\n.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png\n :target: https://runboat.odoo-community.org/builds?repo=OCA/reporting-engine&target_branch=14.0\n :alt: Try me on Runboat\n\n|badge1| |badge2| |badge3| |badge4| |badge5|\n\nThis module provides a basic report class to generate csv report.\n\n**Table of contents**\n\n.. contents::\n :local:\n\nConfiguration\n=============\n\nIn case the exported CSV report should be encoded in another system than UTF-8, following\nfields of the report record (*Settings > Technical > Reports*) should be populated accordingly.\n\n* Encoding: set an encoding system (such as cp932)\n* Encode Error Handling: select 'Ignore' or 'Replace' as necessary.\n\n * 'Ignore': in case of an encoding error, the problematic character will be removed from the exported file.\n * 'Replace': in case of an encoding error, the problematic character will be replaced with '?' symbol.\n * Leaving the field blank: in case of an encoding error, the report generation fails with an error message.\n\nUsage\n=====\n\nAn example of CSV report for partners on a module called `module_name`:\n\nA python class ::\n\n from odoo import models\n\n class PartnerCSV(models.AbstractModel):\n _name = 'report.report_csv.partner_csv'\n _inherit = 'report.report_csv.abstract'\n\n def generate_csv_report(self, writer, data, partners):\n writer.writeheader()\n for obj in partners:\n writer.writerow({\n 'name': obj.name,\n 'email': obj.email,\n })\n\n def csv_report_options(self):\n res = super().csv_report_options()\n res['fieldnames'].append('name')\n res['fieldnames'].append('email')\n res['delimiter'] = ';'\n res['quoting'] = csv.QUOTE_ALL\n return res\n\n\nA report XML record ::\n\n <report\n id=\"partner_csv\"\n model=\"res.partner\"\n string=\"Print to CSV\"\n report_type=\"csv\"\n name=\"module_name.report_name\"\n file=\"res_partner\"\n attachment_use=\"False\"\n />\n\nUpdate encoding with an appropriate value (e.g. cp932) as necessary.\n\nBug Tracker\n===========\n\nBugs are tracked on `GitHub Issues <https://github.com/OCA/reporting-engine/issues>`_.\nIn case of trouble, please check there if your issue has already been reported.\nIf you spotted it first, help us to smash it by providing a detailed and welcomed\n`feedback <https://github.com/OCA/reporting-engine/issues/new?body=module:%20report_csv%0Aversion:%2014.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.\n\nDo not contact contributors directly about support or help with technical issues.\n\nCredits\n=======\n\nAuthors\n~~~~~~~\n\n* Creu Blanca\n\nContributors\n~~~~~~~~~~~~\n\n* Enric Tobella <etobella@creublanca.es>\n* Jaime Arroyo <jaime.arroyo@creublanca.es>\n* Rattapong Chokmasermkul <rattapongc@ecosoft.co.th>\n* `Quartile <https://www.quartile.co>`__:\n\n * Aung Ko Ko Lin\n\nMaintainers\n~~~~~~~~~~~\n\nThis module is maintained by the OCA.\n\n.. image:: https://odoo-community.org/logo.png\n :alt: Odoo Community Association\n :target: https://odoo-community.org\n\nOCA, or the Odoo Community Association, is a nonprofit organization whose\nmission is to support the collaborative development of Odoo features and\npromote its widespread use.\n\nThis module is part of the `OCA/reporting-engine <https://github.com/OCA/reporting-engine/tree/14.0/report_csv>`_ project on GitHub.\n\nYou are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.\n",
"bugtrack_url": null,
"license": "AGPL-3",
"summary": "Base module to create csv report",
"version": "14.0.1.1.0",
"project_urls": {
"Homepage": "https://github.com/OCA/reporting-engine"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e95a08a7fb18b0b7f888eaaf38933876732a66f55d25d108e95a7f07e7e9fb3c",
"md5": "9a6f5a12075f481b653d955dbb21ae89",
"sha256": "86653ef2922305267e0e2ed1c7da12049ff97fff9099671be85e028f4ed2d2fb"
},
"downloads": -1,
"filename": "odoo14_addon_report_csv-14.0.1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9a6f5a12075f481b653d955dbb21ae89",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 35009,
"upload_time": "2025-01-06T12:27:38",
"upload_time_iso_8601": "2025-01-06T12:27:38.925879Z",
"url": "https://files.pythonhosted.org/packages/e9/5a/08a7fb18b0b7f888eaaf38933876732a66f55d25d108e95a7f07e7e9fb3c/odoo14_addon_report_csv-14.0.1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-06 12:27:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OCA",
"github_project": "reporting-engine",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "cryptography",
"specs": []
},
{
"name": "endesive",
"specs": []
},
{
"name": "mock",
"specs": []
},
{
"name": "openpyxl",
"specs": []
},
{
"name": "py3o.formats",
"specs": []
},
{
"name": "py3o.template",
"specs": []
}
],
"lcname": "odoo14-addon-report-csv"
}
JSON
