Search 1.9 billion lines of Odoo code on GitHub
barcodes_generator_abstract
<h1 class="title">Generate Barcodes (Abstract)</h1>
<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/stock-logistics-barcode/tree/16.0/barcodes_generator_abstract"><img alt="OCA/stock-logistics-barcode" src="https://img.shields.io/badge/github-OCA%2Fstock--logistics--barcode-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/stock-logistics-barcode-16-0/stock-logistics-barcode-16-0-barcodes_generator_abstract"><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/150/16.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p>This module extends Odoo functionality, allowing user to generate barcode
depending on a given barcode rule for any Model.</p>
<p>For example, if the barcode pattern is "20.....{NNNDD}":</p>
<ul class="simple">
<li>the EAN13 code will begin with '20',</li>
<li>followed by 5 digits (named <em>Barcode Base</em> in this module),</li>
<li>followed by 5 others digits to define the variable price with 2 decimals,</li>
<li>the last digit (the 13rd digit) is the control digit (i.e. the checksum).</li>
</ul>
<p>With this module, it is possible to:</p>
<ul class="simple">
<li>Affect a pattern (barcode.rule) to a model</li>
<li><dl class="first docutils">
<dt>Define a Barcode base:</dt>
<dd><ul class="first last">
<li>manually, if the base of the barcode must be set by a user (typically an
internal code defined in your company).</li>
<li>automatically by a sequence, if you want to let Odoo increment a
sequence (typical case of a customer number incrementation).</li>
</ul>
</dd>
</dl>
</li>
<li>Generate a barcode, based on the defined pattern and the barcode base</li>
</ul>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#installation" id="id1">Installation</a></li>
<li><a class="reference internal" href="#configuration" id="id2">Configuration</a></li>
<li><a class="reference internal" href="#usage" id="id3">Usage</a><ul>
<li><a class="reference internal" href="#note" id="id4">Note</a></li>
</ul>
</li>
<li><a class="reference internal" href="#known-issues-roadmap" id="id5">Known issues / Roadmap</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id6">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id7">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id8">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id9">Contributors</a></li>
<li><a class="reference internal" href="#other-credits" id="id10">Other credits</a></li>
<li><a class="reference internal" href="#images" id="id11">Images</a></li>
<li><a class="reference internal" href="#maintainers" id="id12">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<a name="installation"></a>
<h2><a class="toc-backref" href="#id1">Installation</a></h2>
<p>This module use an extra python library named 'python-barcode' you should install
to make barcode generation works properly.</p>
<p><code>sudo pip install python-barcode</code></p>
<a name="configuration"></a>
<h2><a class="toc-backref" href="#id2">Configuration</a></h2>
<p>To configure this module, you need to:</p>
<ul class="simple">
<li>Go to Settings / Technical / Sequences & Identifiers / Barcode Nomenclatures</li>
<li>Select a Nomenclature</li>
<li>Create or select a rule</li>
</ul>
<img alt="https://raw.githubusercontent.com/OCA/stock-logistics-barcode/16.0/barcodes_generator_abstract/static/description/barcode_nomenclature_form.png" src="https://raw.githubusercontent.com/OCA/stock-logistics-barcode/16.0/barcodes_generator_abstract/static/description/barcode_nomenclature_form.png" />
<ul class="simple">
<li><dl class="first docutils">
<dt>For manual generation, set:</dt>
<dd><ul class="first last">
<li>'Base set Manually' in 'Generate Type'</li>
<li>Set the model</li>
</ul>
</dd>
</dl>
</li>
</ul>
<img alt="https://raw.githubusercontent.com/OCA/stock-logistics-barcode/16.0/barcodes_generator_abstract/static/description/barcode_rule_form_manual.png" src="https://raw.githubusercontent.com/OCA/stock-logistics-barcode/16.0/barcodes_generator_abstract/static/description/barcode_rule_form_manual.png" />
<ul class="simple">
<li><dl class="first docutils">
<dt>For automatic generation, set:</dt>
<dd><ul class="first last">
<li>'Base managed by Sequence' in 'Generate Type'</li>
<li>Set the model</li>
<li>Generate a new sequence by button, or affect a existing one</li>
</ul>
</dd>
</dl>
</li>
</ul>
<img alt="https://raw.githubusercontent.com/OCA/stock-logistics-barcode/16.0/barcodes_generator_abstract/static/description/barcode_rule_form_sequence.png" src="https://raw.githubusercontent.com/OCA/stock-logistics-barcode/16.0/barcodes_generator_abstract/static/description/barcode_rule_form_sequence.png" />
<p>In all cases, padding will be computed automaticaly, based on the number
of '.' in the Barcode Pattern field.</p>
<a name="usage"></a>
<h2><a class="toc-backref" href="#id3">Usage</a></h2>
<p>This module is an abstract module. You can configure Barcode Rule, but to
enable this feature, you need to install an extra module for a given model.
This repository provide 'barcodes_generator_product' and
'barcodes_generator_partner' module to generate barcode for product or partner
model.</p>
<p>Alternatively, you can develop a custom module for a custom model. See
'Inheritance' parts.</p>
<p>If you want to generate barcode for another model, you can create a custom
module that depend on 'barcodes_generator_abstract' and inherit your model
like that:</p>
<pre class="code">
<code class="code">class MyModel(models.Model):
_name = 'my.model'
_inherit = ['my.model', 'barcode.generate.mixin']
class barcode_rule(models.Model):
_inherit = 'barcode.rule'
generate_model = fields.Selection(selection_add=[('my.model', 'My Model')])</code>
</pre>
<p>Eventually, you should inherit your model view adding buttons and fields.</p>
<a name="note"></a>
<h3><a class="toc-backref" href="#id4">Note</a></h3>
<p>Your model should have a field 'barcode' defined.</p>
<a name="known-issues-roadmap"></a>
<h2><a class="toc-backref" href="#id5">Known issues / Roadmap</a></h2>
<ul class="simple">
<li>On barcode.rule model, constraint and domain system could be set between
'type' and 'generate_model' fields.</li>
<li>Cache is being cleared in a constraint in <cite>barcode.rule</cite>. Mutating in a
constraint is bad practice & should be moved somewhere.</li>
</ul>
<a name="bug-tracker"></a>
<h2><a class="toc-backref" href="#id6">Bug Tracker</a></h2>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/stock-logistics-barcode/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/stock-logistics-barcode/issues/new?body=module:%20barcodes_generator_abstract%0Aversion:%2016.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>
<a name="credits"></a>
<h2><a class="toc-backref" href="#id7">Credits</a></h2>
<a name="authors"></a>
<h3><a class="toc-backref" href="#id8">Authors</a></h3>
<ul class="simple">
<li>GRAP</li>
<li>La Louve</li>
<li>LasLabs</li>
</ul>
<a name="contributors"></a>
<h3><a class="toc-backref" href="#id9">Contributors</a></h3>
<ul class="simple">
<li>Sylvain LE GAL (<a class="reference external" href="https://twitter.com/legalsylvain">https://twitter.com/legalsylvain</a>)</li>
<li>Dave Lasley <<a class="reference external" href="mailto:dave@laslabs.com">dave@laslabs.com</a>></li>
<li><a class="reference external" href="https://www.tecnativa.com">Tecnativa</a>:<ul>
<li>Carlos Roca</li>
</ul>
</li>
</ul>
<a name="other-credits"></a>
<h3><a class="toc-backref" href="#id10">Other credits</a></h3>
<a name="images"></a>
<h3><a class="toc-backref" href="#id11">Images</a></h3>
<ul class="simple">
<li>Icon of the module is based on the Oxygen Team work and is under LGPL licence:
<a class="reference external" href="http://www.iconarchive.com/show/oxygen-icons-by-oxygen-icons.org.html">http://www.iconarchive.com/show/oxygen-icons-by-oxygen-icons.org.html</a></li>
</ul>
<a name="maintainers"></a>
<h3><a class="toc-backref" href="#id12">Maintainers</a></h3>
<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>Current <a class="reference external" href="https://odoo-community.org/page/maintainer-role">maintainer</a>:</p>
<p><a class="reference external" href="https://github.com/legalsylvain"><img alt="legalsylvain" src="https://github.com/legalsylvain.png?size=40px" /></a></p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/stock-logistics-barcode/tree/16.0/barcodes_generator_abstract">OCA/stock-logistics-barcode</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>