Browse Source
Merge pull request #324 from Tecnativa/10.0-mig-report_qr
Merge pull request #324 from Tecnativa/10.0-mig-report_qr
[MIG] report_qr: Migration to 10.0pull/320/head
Pedro M. Baeza
5 years ago
committed by
GitHub
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
16 changed files with 701 additions and 0 deletions
-
107report_qr/README.rst
-
2report_qr/__init__.py
-
21report_qr/__manifest__.py
-
2report_qr/controllers/__init__.py
-
24report_qr/controllers/qr.py
-
2report_qr/models/__init__.py
-
39report_qr/models/report.py
-
5report_qr/readme/CONTRIBUTORS.rst
-
13report_qr/readme/DESCRIPTION.rst
-
18report_qr/readme/USAGE.rst
-
BINreport_qr/static/description/icon.png
-
446report_qr/static/description/index.html
-
BINreport_qr/static/description/new_qr.png
-
BINreport_qr/static/description/old_qr.png
-
1report_qr/tests/__init__.py
-
21report_qr/tests/test_report_qr.py
@ -0,0 +1,107 @@ |
|||
============== |
|||
Web QR Manager |
|||
============== |
|||
|
|||
.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
|||
!! 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/11.0/report_qr |
|||
: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-11-0/reporting-engine-11-0-report_qr |
|||
: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/11.0 |
|||
:alt: Try me on Runbot |
|||
|
|||
|badge1| |badge2| |badge3| |badge4| |badge5| |
|||
|
|||
This module allows to print QR in better structure than the standard odoo. |
|||
|
|||
The original image looks like the following |
|||
|
|||
.. figure:: https://raw.githubusercontent.com/OCA/reporting-engine/11.0/report_qr/static/description/old_qr.png |
|||
:alt: Original QR |
|||
:width: 100 px |
|||
|
|||
With the new generator, it looks like: |
|||
|
|||
.. figure:: https://raw.githubusercontent.com/OCA/reporting-engine/11.0/report_qr/static/description/new_qr.png |
|||
:alt: New QR |
|||
:width: 100 px |
|||
|
|||
**Table of contents** |
|||
|
|||
.. contents:: |
|||
:local: |
|||
|
|||
Usage |
|||
===== |
|||
|
|||
When creating new reports, you should use a path like the following:: |
|||
|
|||
<img t-att-src="'/report/qr/?value=%s&error_correction=%s' % ('HELLO WORLD!', 3)" style="width:100;height:100"/> |
|||
|
|||
|
|||
The **error_correction** parameter controls the error correction used for the QR Code. The following four constants are made available: |
|||
|
|||
* **error_correction** = 1: About 7% or less errors can be corrected. |
|||
* **error_correction** = 0: About 15% or less errors can be corrected. |
|||
* **error_correction** = 3: About 25% or less errors can be corrected. |
|||
* **error_correction** = 2: About 30% or less errors can be corrected. |
|||
|
|||
The **box_size** parameter controls how many pixels each "box" of the QR code is. The default is 3. |
|||
The **border** parameter controls how many boxes thick the border should be (the default is 4, which is the minimum according to the specs). |
|||
|
|||
The **version** parameter is an integer from 1 to 40 that controls the size of the QR Code (the smallest, version 1, is a 21x21 matrix). Set to None and use the fit parameter when making the code to determine this automatically. |
|||
|
|||
**fill_color** and **back_color** can change the background and the painting color of the QR, when using the default image factory. |
|||
|
|||
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 smashing it by providing a detailed and welcomed |
|||
`feedback <https://github.com/OCA/reporting-engine/issues/new?body=module:%20report_qr%0Aversion:%2011.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> |
|||
|
|||
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/11.0/report_qr>`_ project on GitHub. |
|||
|
|||
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. |
@ -0,0 +1,2 @@ |
|||
from . import controllers |
|||
from . import models |
@ -0,0 +1,21 @@ |
|||
# -*- coding: utf-8 -*- |
|||
# Copyright 2019 Creu Blanca |
|||
# Copyright 2019 Tecnativa |
|||
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). |
|||
|
|||
{ |
|||
'name': 'Web QR Manager', |
|||
'version': '10.0.1.0.0', |
|||
'author': 'Creu Blanca, ' |
|||
'Tecnativa, ' |
|||
'Odoo Community Association (OCA)', |
|||
'category': 'Sales', |
|||
'website': 'https://github.com/OCA/reporting-engine', |
|||
'license': 'AGPL-3', |
|||
'depends': [ |
|||
'report', |
|||
], |
|||
'data': [ |
|||
], |
|||
'installable': True, |
|||
} |
@ -0,0 +1,2 @@ |
|||
# -*- coding: utf-8 -*- |
|||
from . import qr |
@ -0,0 +1,24 @@ |
|||
# -*- coding: utf-8 -*- |
|||
# Copyright 2019 Creu Blanca |
|||
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html). |
|||
import werkzeug |
|||
from odoo import http |
|||
from odoo.http import request |
|||
|
|||
|
|||
class Home(http.Controller): |
|||
|
|||
@http.route('/report/qr', type='http', auth="public") |
|||
def report_qr(self, value, box_size=3, border=3, factory='png', **kwargs): |
|||
try: |
|||
barcode = request.env['report'].qr_generate( |
|||
value, box_size=box_size, border=border, |
|||
factory=factory, **kwargs) |
|||
except (ValueError, AttributeError): |
|||
raise werkzeug.exceptions.HTTPException( |
|||
description='Cannot convert into barcode.') |
|||
if factory != 'png': |
|||
return request.make_response( |
|||
barcode, headers=[('Content-Type', 'image/svg+xml')]) |
|||
return request.make_response( |
|||
barcode, headers=[('Content-Type', 'image/png')]) |
@ -0,0 +1,2 @@ |
|||
# -*- coding: utf-8 -*- |
|||
from . import report |
@ -0,0 +1,39 @@ |
|||
# -*- coding: utf-8 -*- |
|||
# Copyright 2019 Creu Blanca |
|||
# Copyright 2019 Tecnativa - David Vidal |
|||
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html). |
|||
from odoo import api, models |
|||
import qrcode |
|||
from qrcode.image import svg, pil |
|||
import io |
|||
|
|||
|
|||
class Report(models.Model): |
|||
_inherit = 'report' |
|||
|
|||
@api.model |
|||
def qr_generate(self, value, box_size=3, border=5, |
|||
factory='png', **kwargs): |
|||
factories = { |
|||
'png': pil.PilImage, |
|||
'svg': svg.SvgImage, |
|||
'svg-fragment': svg.SvgFragmentImage, |
|||
'svg-path': svg.SvgPathImage, |
|||
} |
|||
# Color parameters seem to be inverted in the library |
|||
back_color = kwargs.pop("back_color", "black") |
|||
fill_color = kwargs.pop("fill_color", "white") |
|||
try: |
|||
# Defaults to png if the argument is unknown |
|||
image_factory = factories.get(factory, pil.PilImage) |
|||
qr = qrcode.QRCode( |
|||
box_size=box_size, border=border, |
|||
image_factory=image_factory, **kwargs) |
|||
qr.add_data(value) |
|||
qr.make() |
|||
img = qr.make_image(fill_color=fill_color, back_color=back_color) |
|||
arr = io.BytesIO() |
|||
img.save(arr) |
|||
return arr.getvalue() |
|||
except Exception: |
|||
raise ValueError("Cannot convert into barcode.") |
@ -0,0 +1,5 @@ |
|||
* Enric Tobella <etobella@creublanca.es> |
|||
|
|||
* `Tecnativa <https://www.tecnativa.com>`_: |
|||
|
|||
* David Vidal |
@ -0,0 +1,13 @@ |
|||
This module allows to print QR in better structure than the standard odoo. |
|||
|
|||
The original image looks like the following |
|||
|
|||
.. figure:: static/description/old_qr.png |
|||
:alt: Original QR |
|||
:width: 100 px |
|||
|
|||
With the new generator, it looks like: |
|||
|
|||
.. figure:: static/description/new_qr.png |
|||
:alt: New QR |
|||
:width: 100 px |
@ -0,0 +1,18 @@ |
|||
When creating new reports, you should use a path like the following:: |
|||
|
|||
<img t-att-src="'/report/qr/?value=%s&error_correction=%s' % ('HELLO WORLD!', 3)" style="width:100;height:100"/> |
|||
|
|||
|
|||
The **error_correction** parameter controls the error correction used for the QR Code. The following four constants are made available: |
|||
|
|||
* **error_correction** = 1: About 7% or less errors can be corrected. |
|||
* **error_correction** = 0: About 15% or less errors can be corrected. |
|||
* **error_correction** = 3: About 25% or less errors can be corrected. |
|||
* **error_correction** = 2: About 30% or less errors can be corrected. |
|||
|
|||
The **box_size** parameter controls how many pixels each "box" of the QR code is. The default is 3. |
|||
The **border** parameter controls how many boxes thick the border should be (the default is 4, which is the minimum according to the specs). |
|||
|
|||
The **version** parameter is an integer from 1 to 40 that controls the size of the QR Code (the smallest, version 1, is a 21x21 matrix). Set to None and use the fit parameter when making the code to determine this automatically. |
|||
|
|||
**fill_color** and **back_color** can change the background and the painting color of the QR, when using the default image factory. |
After Width: 128 | Height: 128 | Size: 9.2 KiB |
@ -0,0 +1,446 @@ |
|||
<?xml version="1.0" encoding="utf-8" ?> |
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
|||
<head> |
|||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
|||
<meta name="generator" content="Docutils 0.13.1: http://docutils.sourceforge.net/" /> |
|||
<title>Web QR Manager</title> |
|||
<style type="text/css"> |
|||
|
|||
/* |
|||
:Author: David Goodger (goodger@python.org) |
|||
:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $ |
|||
:Copyright: This stylesheet has been placed in the public domain. |
|||
|
|||
Default cascading style sheet for the HTML output of Docutils. |
|||
|
|||
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to |
|||
customize this style sheet. |
|||
*/ |
|||
|
|||
/* used to remove borders from tables and images */ |
|||
.borderless, table.borderless td, table.borderless th { |
|||
border: 0 } |
|||
|
|||
table.borderless td, table.borderless th { |
|||
/* Override padding for "table.docutils td" with "! important". |
|||
The right padding separates the table cells. */ |
|||
padding: 0 0.5em 0 0 ! important } |
|||
|
|||
.first { |
|||
/* Override more specific margin styles with "! important". */ |
|||
margin-top: 0 ! important } |
|||
|
|||
.last, .with-subtitle { |
|||
margin-bottom: 0 ! important } |
|||
|
|||
.hidden { |
|||
display: none } |
|||
|
|||
.subscript { |
|||
vertical-align: sub; |
|||
font-size: smaller } |
|||
|
|||
.superscript { |
|||
vertical-align: super; |
|||
font-size: smaller } |
|||
|
|||
a.toc-backref { |
|||
text-decoration: none ; |
|||
color: black } |
|||
|
|||
blockquote.epigraph { |
|||
margin: 2em 5em ; } |
|||
|
|||
dl.docutils dd { |
|||
margin-bottom: 0.5em } |
|||
|
|||
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] { |
|||
overflow: hidden; |
|||
} |
|||
|
|||
/* Uncomment (and remove this text!) to get bold-faced definition list terms |
|||
dl.docutils dt { |
|||
font-weight: bold } |
|||
*/ |
|||
|
|||
div.abstract { |
|||
margin: 2em 5em } |
|||
|
|||
div.abstract p.topic-title { |
|||
font-weight: bold ; |
|||
text-align: center } |
|||
|
|||
div.admonition, div.attention, div.caution, div.danger, div.error, |
|||
div.hint, div.important, div.note, div.tip, div.warning { |
|||
margin: 2em ; |
|||
border: medium outset ; |
|||
padding: 1em } |
|||
|
|||
div.admonition p.admonition-title, div.hint p.admonition-title, |
|||
div.important p.admonition-title, div.note p.admonition-title, |
|||
div.tip p.admonition-title { |
|||
font-weight: bold ; |
|||
font-family: sans-serif } |
|||
|
|||
div.attention p.admonition-title, div.caution p.admonition-title, |
|||
div.danger p.admonition-title, div.error p.admonition-title, |
|||
div.warning p.admonition-title, .code .error { |
|||
color: red ; |
|||
font-weight: bold ; |
|||
font-family: sans-serif } |
|||
|
|||
/* Uncomment (and remove this text!) to get reduced vertical space in |
|||
compound paragraphs. |
|||
div.compound .compound-first, div.compound .compound-middle { |
|||
margin-bottom: 0.5em } |
|||
|
|||
div.compound .compound-last, div.compound .compound-middle { |
|||
margin-top: 0.5em } |
|||
*/ |
|||
|
|||
div.dedication { |
|||
margin: 2em 5em ; |
|||
text-align: center ; |
|||
font-style: italic } |
|||
|
|||
div.dedication p.topic-title { |
|||
font-weight: bold ; |
|||
font-style: normal } |
|||
|
|||
div.figure { |
|||
margin-left: 2em ; |
|||
margin-right: 2em } |
|||
|
|||
div.footer, div.header { |
|||
clear: both; |
|||
font-size: smaller } |
|||
|
|||
div.line-block { |
|||
display: block ; |
|||
margin-top: 1em ; |
|||
margin-bottom: 1em } |
|||
|
|||
div.line-block div.line-block { |
|||
margin-top: 0 ; |
|||
margin-bottom: 0 ; |
|||
margin-left: 1.5em } |
|||
|
|||
div.sidebar { |
|||
margin: 0 0 0.5em 1em ; |
|||
border: medium outset ; |
|||
padding: 1em ; |
|||
background-color: #ffffee ; |
|||
width: 40% ; |
|||
float: right ; |
|||
clear: right } |
|||
|
|||
div.sidebar p.rubric { |
|||
font-family: sans-serif ; |
|||
font-size: medium } |
|||
|
|||
div.system-messages { |
|||
margin: 5em } |
|||
|
|||
div.system-messages h1 { |
|||
color: red } |
|||
|
|||
div.system-message { |
|||
border: medium outset ; |
|||
padding: 1em } |
|||
|
|||
div.system-message p.system-message-title { |
|||
color: red ; |
|||
font-weight: bold } |
|||
|
|||
div.topic { |
|||
margin: 2em } |
|||
|
|||
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle, |
|||
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle { |
|||
margin-top: 0.4em } |
|||
|
|||
h1.title { |
|||
text-align: center } |
|||
|
|||
h2.subtitle { |
|||
text-align: center } |
|||
|
|||
hr.docutils { |
|||
width: 75% } |
|||
|
|||
img.align-left, .figure.align-left, object.align-left, table.align-left { |
|||
clear: left ; |
|||
float: left ; |
|||
margin-right: 1em } |
|||
|
|||
img.align-right, .figure.align-right, object.align-right, table.align-right { |
|||
clear: right ; |
|||
float: right ; |
|||
margin-left: 1em } |
|||
|
|||
img.align-center, .figure.align-center, object.align-center { |
|||
display: block; |
|||
margin-left: auto; |
|||
margin-right: auto; |
|||
} |
|||
|
|||
table.align-center { |
|||
margin-left: auto; |
|||
margin-right: auto; |
|||
} |
|||
|
|||
.align-left { |
|||
text-align: left } |
|||
|
|||
.align-center { |
|||
clear: both ; |
|||
text-align: center } |
|||
|
|||
.align-right { |
|||
text-align: right } |
|||
|
|||
/* reset inner alignment in figures */ |
|||
div.align-right { |
|||
text-align: inherit } |
|||
|
|||
/* div.align-center * { */ |
|||
/* text-align: left } */ |
|||
|
|||
.align-top { |
|||
vertical-align: top } |
|||
|
|||
.align-middle { |
|||
vertical-align: middle } |
|||
|
|||
.align-bottom { |
|||
vertical-align: bottom } |
|||
|
|||
ol.simple, ul.simple { |
|||
margin-bottom: 1em } |
|||
|
|||
ol.arabic { |
|||
list-style: decimal } |
|||
|
|||
ol.loweralpha { |
|||
list-style: lower-alpha } |
|||
|
|||
ol.upperalpha { |
|||
list-style: upper-alpha } |
|||
|
|||
ol.lowerroman { |
|||
list-style: lower-roman } |
|||
|
|||
ol.upperroman { |
|||
list-style: upper-roman } |
|||
|
|||
p.attribution { |
|||
text-align: right ; |
|||
margin-left: 50% } |
|||
|
|||
p.caption { |
|||
font-style: italic } |
|||
|
|||
p.credits { |
|||
font-style: italic ; |
|||
font-size: smaller } |
|||
|
|||
p.label { |
|||
white-space: nowrap } |
|||
|
|||
p.rubric { |
|||
font-weight: bold ; |
|||
font-size: larger ; |
|||
color: maroon ; |
|||
text-align: center } |
|||
|
|||
p.sidebar-title { |
|||
font-family: sans-serif ; |
|||
font-weight: bold ; |
|||
font-size: larger } |
|||
|
|||
p.sidebar-subtitle { |
|||
font-family: sans-serif ; |
|||
font-weight: bold } |
|||
|
|||
p.topic-title { |
|||
font-weight: bold } |
|||
|
|||
pre.address { |
|||
margin-bottom: 0 ; |
|||
margin-top: 0 ; |
|||
font: inherit } |
|||
|
|||
pre.literal-block, pre.doctest-block, pre.math, pre.code { |
|||
margin-left: 2em ; |
|||
margin-right: 2em } |
|||
|
|||
pre.code .ln { color: grey; } /* line numbers */ |
|||
pre.code, code { background-color: #eeeeee } |
|||
pre.code .comment, code .comment { color: #5C6576 } |
|||
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold } |
|||
pre.code .literal.string, code .literal.string { color: #0C5404 } |
|||
pre.code .name.builtin, code .name.builtin { color: #352B84 } |
|||
pre.code .deleted, code .deleted { background-color: #DEB0A1} |
|||
pre.code .inserted, code .inserted { background-color: #A3D289} |
|||
|
|||
span.classifier { |
|||
font-family: sans-serif ; |
|||
font-style: oblique } |
|||
|
|||
span.classifier-delimiter { |
|||
font-family: sans-serif ; |
|||
font-weight: bold } |
|||
|
|||
span.interpreted { |
|||
font-family: sans-serif } |
|||
|
|||
span.option { |
|||
white-space: nowrap } |
|||
|
|||
span.pre { |
|||
white-space: pre } |
|||
|
|||
span.problematic { |
|||
color: red } |
|||
|
|||
span.section-subtitle { |
|||
/* font-size relative to parent (h1..h6 element) */ |
|||
font-size: 80% } |
|||
|
|||
table.citation { |
|||
border-left: solid 1px gray; |
|||
margin-left: 1px } |
|||
|
|||
table.docinfo { |
|||
margin: 2em 4em } |
|||
|
|||
table.docutils { |
|||
margin-top: 0.5em ; |
|||
margin-bottom: 0.5em } |
|||
|
|||
table.footnote { |
|||
border-left: solid 1px black; |
|||
margin-left: 1px } |
|||
|
|||
table.docutils td, table.docutils th, |
|||
table.docinfo td, table.docinfo th { |
|||
padding-left: 0.5em ; |
|||
padding-right: 0.5em ; |
|||
vertical-align: top } |
|||
|
|||
table.docutils th.field-name, table.docinfo th.docinfo-name { |
|||
font-weight: bold ; |
|||
text-align: left ; |
|||
white-space: nowrap ; |
|||
padding-left: 0 } |
|||
|
|||
/* "booktabs" style (no vertical lines) */ |
|||
table.docutils.booktabs { |
|||
border: 0px; |
|||
border-top: 2px solid; |
|||
border-bottom: 2px solid; |
|||
border-collapse: collapse; |
|||
} |
|||
table.docutils.booktabs * { |
|||
border: 0px; |
|||
} |
|||
table.docutils.booktabs th { |
|||
border-bottom: thin solid; |
|||
text-align: left; |
|||
} |
|||
|
|||
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils, |
|||
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils { |
|||
font-size: 100% } |
|||
|
|||
ul.auto-toc { |
|||
list-style-type: none } |
|||
|
|||
</style> |
|||
</head> |
|||
<body> |
|||
<div class="document" id="web-qr-manager"> |
|||
<h1 class="title">Web QR Manager</h1> |
|||
|
|||
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
|||
!! This file is generated by oca-gen-addon-readme !! |
|||
!! changes will be overwritten. !! |
|||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! --> |
|||
<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/reporting-engine/tree/11.0/report_qr"><img alt="OCA/reporting-engine" src="https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/reporting-engine-11-0/reporting-engine-11-0-report_qr"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/143/11.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p> |
|||
<p>This module allows to print QR in better structure than the standard odoo.</p> |
|||
<p>The original image looks like the following</p> |
|||
<div class="figure"> |
|||
<img alt="Original QR" src="https://raw.githubusercontent.com/OCA/reporting-engine/11.0/report_qr/static/description/old_qr.png" style="width: 100px;" /> |
|||
</div> |
|||
<p>With the new generator, it looks like:</p> |
|||
<div class="figure"> |
|||
<img alt="New QR" src="https://raw.githubusercontent.com/OCA/reporting-engine/11.0/report_qr/static/description/new_qr.png" style="width: 100px;" /> |
|||
</div> |
|||
<p><strong>Table of contents</strong></p> |
|||
<div class="contents local topic" id="contents"> |
|||
<ul class="simple"> |
|||
<li><a class="reference internal" href="#usage" id="id1">Usage</a></li> |
|||
<li><a class="reference internal" href="#bug-tracker" id="id2">Bug Tracker</a></li> |
|||
<li><a class="reference internal" href="#credits" id="id3">Credits</a><ul> |
|||
<li><a class="reference internal" href="#authors" id="id4">Authors</a></li> |
|||
<li><a class="reference internal" href="#contributors" id="id5">Contributors</a></li> |
|||
<li><a class="reference internal" href="#maintainers" id="id6">Maintainers</a></li> |
|||
</ul> |
|||
</li> |
|||
</ul> |
|||
</div> |
|||
<div class="section" id="usage"> |
|||
<h1><a class="toc-backref" href="#id1">Usage</a></h1> |
|||
<p>When creating new reports, you should use a path like the following:</p> |
|||
<pre class="literal-block"> |
|||
<img t-att-src="'/report/qr/?value=%s&amp;error_correction=%s' % ('HELLO WORLD!', 3)" style="width:100;height:100"/> |
|||
</pre> |
|||
<p>The <strong>error_correction</strong> parameter controls the error correction used for the QR Code. The following four constants are made available:</p> |
|||
<ul class="simple"> |
|||
<li><strong>error_correction</strong> = 1: About 7% or less errors can be corrected.</li> |
|||
<li><strong>error_correction</strong> = 0: About 15% or less errors can be corrected.</li> |
|||
<li><strong>error_correction</strong> = 3: About 25% or less errors can be corrected.</li> |
|||
<li><strong>error_correction</strong> = 2: About 30% or less errors can be corrected.</li> |
|||
</ul> |
|||
<p>The <strong>box_size</strong> parameter controls how many pixels each “box” of the QR code is. The default is 3. |
|||
The <strong>border</strong> parameter controls how many boxes thick the border should be (the default is 4, which is the minimum according to the specs).</p> |
|||
<p>The <strong>version</strong> parameter is an integer from 1 to 40 that controls the size of the QR Code (the smallest, version 1, is a 21x21 matrix). Set to None and use the fit parameter when making the code to determine this automatically.</p> |
|||
<p><strong>fill_color</strong> and <strong>back_color</strong> can change the background and the painting color of the QR, when using the default image factory.</p> |
|||
</div> |
|||
<div class="section" id="bug-tracker"> |
|||
<h1><a class="toc-backref" href="#id2">Bug Tracker</a></h1> |
|||
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/reporting-engine/issues">GitHub Issues</a>. |
|||
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 |
|||
<a class="reference external" href="https://github.com/OCA/reporting-engine/issues/new?body=module:%20report_qr%0Aversion:%2011.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p> |
|||
<p>Do not contact contributors directly about support or help with technical issues.</p> |
|||
</div> |
|||
<div class="section" id="credits"> |
|||
<h1><a class="toc-backref" href="#id3">Credits</a></h1> |
|||
<div class="section" id="authors"> |
|||
<h2><a class="toc-backref" href="#id4">Authors</a></h2> |
|||
<ul class="simple"> |
|||
<li>Creu Blanca</li> |
|||
</ul> |
|||
</div> |
|||
<div class="section" id="contributors"> |
|||
<h2><a class="toc-backref" href="#id5">Contributors</a></h2> |
|||
<ul class="simple"> |
|||
<li>Enric Tobella <<a class="reference external" href="mailto:etobella@creublanca.es">etobella@creublanca.es</a>></li> |
|||
</ul> |
|||
</div> |
|||
<div class="section" id="maintainers"> |
|||
<h2><a class="toc-backref" href="#id6">Maintainers</a></h2> |
|||
<p>This module is maintained by the OCA.</p> |
|||
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a> |
|||
<p>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.</p> |
|||
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/reporting-engine/tree/11.0/report_qr">OCA/reporting-engine</a> project on GitHub.</p> |
|||
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p> |
|||
</div> |
|||
</div> |
|||
</div> |
|||
</body> |
|||
</html> |
After Width: 81 | Height: 81 | Size: 271 B |
After Width: 300 | Height: 300 | Size: 4.8 KiB |
@ -0,0 +1 @@ |
|||
from . import test_report_qr |
@ -0,0 +1,21 @@ |
|||
# Copyright 2019 Creu Blanca |
|||
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). |
|||
|
|||
from odoo.tests.common import HttpCase |
|||
|
|||
|
|||
class TestReportQr(HttpCase): |
|||
|
|||
def test_qr_generation(self): |
|||
data = 'TEST' |
|||
image = self.url_open('/report/qr?value=%s' % data) |
|||
self.assertEqual(image.headers['Content-type'], 'image/png') |
|||
|
|||
def test_qr_overflow(self): |
|||
"""There is a QR limitation for 4296 characters, we will test that an |
|||
Exception is raised""" |
|||
new_data = '' |
|||
for i in range(0, 1500): |
|||
new_data += 'TEST' |
|||
with self.assertRaises(Exception): |
|||
self.env['report'].qr_generate(new_data) |
Write
Preview
Loading…
Cancel
Save
Reference in new issue