audrius/stock-logistics-warehouse
1
0
Fork 1
mirror of https://github.com/OCA/stock-logistics-warehouse.git synced 2025-01-21 14:27:28 +02:00
Code Issues Packages Projects Releases Wiki Activity

[UPD] README.rst

Browse Source
This commit is contained in:
OCA-git-bot
2020-06-09 08:09:46 +00:00
parent 080f75e00d
commit bae259af56
2 changed files with 83 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
stock_packaging_calculator/README.rst
View File

@@ -25,9 +25,21 @@ Stock packaging calculator
|badge1| |badge2| |badge3| |badge4| |badge5|
Basic module providing an helper method to calculate the quantity of product by packaging.
.. IMPORTANT::
This is an alpha version, the data model and design can change at any time without warning.
Only for development or testing purpose, do not use in production.
`More details on development status <https://odoo-community.org/page/development-status>`_
**Table of contents**
.. contents::
:local:
Usage
=====
Imagine you have the following packagings:
* Pallet: 1000 Units
@@ -38,21 +50,32 @@ and you have to pick from your warehouse 2860 Units.
Then you can do:
>>> product.product_qty_by_packaging(2860)
.. code-block::
[(2, "Pallet"), (1, "Big Box"), (7, "Box"), (10, "Units")]
>>> product.product_qty_by_packaging(2860)
[
{"id": 1, "qty": 2, "name": "Pallet"},
{"id": 2, "qty": 1, "name": "Big box"},
{"id": 3, "qty": 7, "name": "Box"},
{"id": 100, "qty": 10, "name": "Units"},
]
With this you can show a proper message to warehouse operators to quickly pick the quantity they need.
.. IMPORTANT::
This is an alpha version, the data model and design can change at any time without warning.
Only for development or testing purpose, do not use in production.
`More details on development status <https://odoo-community.org/page/development-status>`_
Optionally you can get contained packaging by passing `with_contained` flag:
**Table of contents**
.. contents::
:local:
.. code-block::
>>> product.product_qty_by_packaging(2860, with_contained=True)
[
{"id": 1, "qty": 2, "name": "Pallet", "contained": [{"id": 2, "qty": 2, "name": "Big box"}]},
{"id": 2, "qty": 1, "name": "Big box", "contained": [{"id": 3, "qty": 10, "name": "Box"}]},
{"id": 3, "qty": 7, "name": "Box", "contained": [{"id": 100, "qty": 50, "name": "Units"}]},
{"id": 100, "qty": 10, "name": "Units", "contained": []},},
]
Known issues / Roadmap
======================

77
stock_packaging_calculator/static/description/index.html
View File

@@ -369,21 +369,6 @@ ul.auto-toc {
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Alpha" src="https://img.shields.io/badge/maturity-Alpha-red.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-warehouse/tree/13.0/stock_packaging_calculator"><img alt="OCA/stock-logistics-warehouse" src="https://img.shields.io/badge/github-OCA%2Fstock--logistics--warehouse-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/stock-logistics-warehouse-13-0/stock-logistics-warehouse-13-0-stock_packaging_calculator"><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/153/13.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p>Basic module providing an helper method to calculate the quantity of product by packaging.</p>
<p>Imagine you have the following packagings:</p>
<ul class="simple">
<li>Pallet: 1000 Units</li>
<li>Big box: 500 Units</li>
<li>Box: 50 Units</li>
</ul>
<p>and you have to pick from your warehouse 2860 Units.</p>
<p>Then you can do:</p>
<blockquote>
<pre class="doctest-block">
&gt;&gt;&gt; product.product_qty_by_packaging(2860)
</pre>
<p>[(2, “Pallet”), (1, “Big Box”), (7, “Box”), (10, “Units”)]</p>
</blockquote>
<p>With this you can show a proper message to warehouse operators to quickly pick the quantity they need.</p>
<div class="admonition important">
<p class="first admonition-title">Important</p>
<p class="last">This is an alpha version, the data model and design can change at any time without warning.
@@ -393,18 +378,56 @@ Only for development or testing purpose, do not use in production.
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#known-issues-roadmap" id="id1">Known issues / Roadmap</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>
<li><a class="reference internal" href="#usage" id="id1">Usage</a></li>
<li><a class="reference internal" href="#known-issues-roadmap" id="id2">Known issues / Roadmap</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id3">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id4">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id5">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id6">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="id7">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="usage">
<h1><a class="toc-backref" href="#id1">Usage</a></h1>
<p>Imagine you have the following packagings:</p>
<ul class="simple">
<li>Pallet: 1000 Units</li>
<li>Big box: 500 Units</li>
<li>Box: 50 Units</li>
</ul>
<p>and you have to pick from your warehouse 2860 Units.</p>
<p>Then you can do:</p>
<blockquote>
<pre class="code literal-block">
&gt;&gt;&gt; product.product_qty_by_packaging(2860)
[
{&quot;id&quot;: 1, &quot;qty&quot;: 2, &quot;name&quot;: &quot;Pallet&quot;},
{&quot;id&quot;: 2, &quot;qty&quot;: 1, &quot;name&quot;: &quot;Big box&quot;},
{&quot;id&quot;: 3, &quot;qty&quot;: 7, &quot;name&quot;: &quot;Box&quot;},
{&quot;id&quot;: 100, &quot;qty&quot;: 10, &quot;name&quot;: &quot;Units&quot;},
]
</pre>
</blockquote>
<p>With this you can show a proper message to warehouse operators to quickly pick the quantity they need.</p>
<p>Optionally you can get contained packaging by passing <cite>with_contained</cite> flag:</p>
<blockquote>
<pre class="code literal-block">
&gt;&gt;&gt; product.product_qty_by_packaging(2860, with_contained=True)
[
{&quot;id&quot;: 1, &quot;qty&quot;: 2, &quot;name&quot;: &quot;Pallet&quot;, &quot;contained&quot;: [{&quot;id&quot;: 2, &quot;qty&quot;: 2, &quot;name&quot;: &quot;Big box&quot;}]},
{&quot;id&quot;: 2, &quot;qty&quot;: 1, &quot;name&quot;: &quot;Big box&quot;, &quot;contained&quot;: [{&quot;id&quot;: 3, &quot;qty&quot;: 10, &quot;name&quot;: &quot;Box&quot;}]},
{&quot;id&quot;: 3, &quot;qty&quot;: 7, &quot;name&quot;: &quot;Box&quot;, &quot;contained&quot;: [{&quot;id&quot;: 100, &quot;qty&quot;: 50, &quot;name&quot;: &quot;Units&quot;}]},
{&quot;id&quot;: 100, &quot;qty&quot;: 10, &quot;name&quot;: &quot;Units&quot;, &quot;contained&quot;: []},},
]
</pre>
</blockquote>
</div>
<div class="section" id="known-issues-roadmap">
<h1><a class="toc-backref" href="#id1">Known issues / Roadmap</a></h1>
<h1><a class="toc-backref" href="#id2">Known issues / Roadmap</a></h1>
<p>TODO</p>
<ol class="arabic simple">
<li>Fractional quantities (eg: 0.5 Kg) are lost when counting units</li>
@@ -412,7 +435,7 @@ Only for development or testing purpose, do not use in production.
</ol>
</div>
<div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#id2">Bug Tracker</a></h1>
<h1><a class="toc-backref" href="#id3">Bug Tracker</a></h1>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/stock-logistics-warehouse/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
@@ -420,21 +443,21 @@ If you spotted it first, help us smashing it by providing a detailed and welcome
<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>
<h1><a class="toc-backref" href="#id4">Credits</a></h1>
<div class="section" id="authors">
<h2><a class="toc-backref" href="#id4">Authors</a></h2>
<h2><a class="toc-backref" href="#id5">Authors</a></h2>
<ul class="simple">
<li>Camptocamp</li>
</ul>
</div>
<div class="section" id="contributors">
<h2><a class="toc-backref" href="#id5">Contributors</a></h2>
<h2><a class="toc-backref" href="#id6">Contributors</a></h2>
<ul class="simple">
<li>Simone Orsi &lt;<a class="reference external" href="mailto:simahawk&#64;gmail.com">simahawk&#64;gmail.com</a>&gt;</li>
</ul>
</div>
<div class="section" id="maintainers">
<h2><a class="toc-backref" href="#id6">Maintainers</a></h2>
<h2><a class="toc-backref" href="#id7">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