Skip to content

Commit

Permalink
[IMP] stock_warehouse_flow: pre-commit auto fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
peluko00 committed Apr 22, 2024
1 parent 37ec2b7 commit aac5b7a
Show file tree
Hide file tree
Showing 13 changed files with 118 additions and 110 deletions.
81 changes: 43 additions & 38 deletions stock_warehouse_flow/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,35 +17,37 @@ Stock Warehouse Flow
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fwms-lightgray.png?logo=github
:target: https://github.com/OCA/wms/tree/16.0/stock_warehouse_flow
:target: https://github.com/OCA/wms/tree/17.0/stock_warehouse_flow
:alt: OCA/wms
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/wms-16-0/wms-16-0-stock_warehouse_flow
:target: https://translation.odoo-community.org/projects/wms-17-0/wms-17-0-stock_warehouse_flow
: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/wms&target_branch=16.0
:target: https://runboat.odoo-community.org/builds?repo=OCA/wms&target_branch=17.0
:alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

This module introduces the concept of routing flows in order to manage
different delivery routes for a warehouse.

The default behavior of Odoo allows you to have only one delivery route per
warehouse (with one, two or three steps).
With this module, you are now able to manage multiple delivery routes (having
their own rules and operation types), the right one being selected automatically
based on some criterias, like the carrier and any attribute of the stock move
to process.
The default behavior of Odoo allows you to have only one delivery route
per warehouse (with one, two or three steps). With this module, you are
now able to manage multiple delivery routes (having their own rules and
operation types), the right one being selected automatically based on
some criterias, like the carrier and any attribute of the stock move to
process.

This allows you to define a delivery route based on the type of goods to ship,
for instance:
This allows you to define a delivery route based on the type of goods to
ship, for instance:

* whole pallet (pick + ship)
* cold chain goods
* dangerous goods
- whole pallet (pick + ship)
- cold chain goods
- dangerous goods

.. image:: https://raw.githubusercontent.com/OCA/wms/14.0/stock_warehouse_flow/static/description/flow.png
|image_description|

.. |image_description| image:: https://raw.githubusercontent.com/OCA/wms/14.0/stock_warehouse_flow/static/description/flow.png

.. IMPORTANT::
This is an alpha version, the data model and design can change at any time without warning.
Expand All @@ -62,63 +64,66 @@ Configuration

Got to "Inventory > Settings > Routing Flows".

A routing flow can be seen as a helper to generate a delivery route (like the
warehouse is doing automatically). The new route will get its own rules and
operation types that doesn't overlap with the default ones of the warehouse.
A routing flow can be seen as a helper to generate a delivery route
(like the warehouse is doing automatically). The new route will get its
own rules and operation types that doesn't overlap with the default ones
of the warehouse.

A routing flow is responsible to change the warehouse delivery route of a move
by another one depending on some criterias:
A routing flow is responsible to change the warehouse delivery route of
a move by another one depending on some criterias:

* the initial outgoing operation type (usually the default one)
* the carrier
* a custom domain (applied on the move)
- the initial outgoing operation type (usually the default one)
- the carrier
- a custom domain (applied on the move)

This way you are able to change the route a move will take depending on its
carrier and, for instance, the type or the packaging of the product
This way you are able to change the route a move will take depending on
its carrier and, for instance, the type or the packaging of the product
you want to ship.

.. image:: https://raw.githubusercontent.com/OCA/wms/14.0/stock_warehouse_flow/static/description/config.png
|image|

.. |image| image:: https://raw.githubusercontent.com/OCA/wms/14.0/stock_warehouse_flow/static/description/config.png

Usage
=====

When a stock move is confirmed, if a flow is matching all the criteria then
the new delivery route will be automatically applied.
When a stock move is confirmed, if a flow is matching all the criteria
then the new delivery route will be automatically applied.

Known issues / Roadmap
======================

Currently, the module supports only delivery routes, but it could improved to
support reception routes as well.
Currently, the module supports only delivery routes, but it could
improved to support reception routes as well.

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/wms/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/wms/issues/new?body=module:%20stock_warehouse_flow%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
`feedback <https://github.com/OCA/wms/issues/new?body=module:%20stock_warehouse_flow%0Aversion:%2017.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
~~~~~~~
-------

* Camptocamp
* BCIM

Contributors
~~~~~~~~~~~~
------------

* Sébastien Alix <[email protected]>
* Jacques-Etienne Baudoux <[email protected]>
* Michael Tietz (MT Software) <[email protected]>
- Sébastien Alix <[email protected]>
- Jacques-Etienne Baudoux <[email protected]>
- Michael Tietz (MT Software) <[email protected]>

Maintainers
~~~~~~~~~~~
-----------

This module is maintained by the OCA.

Expand All @@ -130,6 +135,6 @@ 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/wms <https://github.com/OCA/wms/tree/16.0/stock_warehouse_flow>`_ project on GitHub.
This module is part of the `OCA/wms <https://github.com/OCA/wms/tree/17.0/stock_warehouse_flow>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
3 changes: 3 additions & 0 deletions stock_warehouse_flow/pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[build-system]
requires = ["whool"]
build-backend = "whool.buildapi"
19 changes: 19 additions & 0 deletions stock_warehouse_flow/readme/CONFIGURE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Got to "Inventory \> Settings \> Routing Flows".

A routing flow can be seen as a helper to generate a delivery route
(like the warehouse is doing automatically). The new route will get its
own rules and operation types that doesn't overlap with the default ones
of the warehouse.

A routing flow is responsible to change the warehouse delivery route of
a move by another one depending on some criterias:

- the initial outgoing operation type (usually the default one)
- the carrier
- a custom domain (applied on the move)

This way you are able to change the route a move will take depending on
its carrier and, for instance, the type or the packaging of the product
you want to ship.

![image](https://raw.githubusercontent.com/OCA/wms/14.0/stock_warehouse_flow/static/description/config.png)
18 changes: 0 additions & 18 deletions stock_warehouse_flow/readme/CONFIGURE.rst

This file was deleted.

3 changes: 3 additions & 0 deletions stock_warehouse_flow/readme/CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- Sébastien Alix \<<[email protected]>\>
- Jacques-Etienne Baudoux \<<[email protected]>\>
- Michael Tietz (MT Software) \<<[email protected]>\>
3 changes: 0 additions & 3 deletions stock_warehouse_flow/readme/CONTRIBUTORS.rst

This file was deleted.

18 changes: 18 additions & 0 deletions stock_warehouse_flow/readme/DESCRIPTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
This module introduces the concept of routing flows in order to manage
different delivery routes for a warehouse.

The default behavior of Odoo allows you to have only one delivery route
per warehouse (with one, two or three steps). With this module, you are
now able to manage multiple delivery routes (having their own rules and
operation types), the right one being selected automatically based on
some criterias, like the carrier and any attribute of the stock move to
process.

This allows you to define a delivery route based on the type of goods to
ship, for instance:

- whole pallet (pick + ship)
- cold chain goods
- dangerous goods

![image_description](https://raw.githubusercontent.com/OCA/wms/14.0/stock_warehouse_flow/static/description/flow.png)
18 changes: 0 additions & 18 deletions stock_warehouse_flow/readme/DESCRIPTION.rst

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
Currently, the module supports only delivery routes, but it could improved to
support reception routes as well.
Currently, the module supports only delivery routes, but it could
improved to support reception routes as well.
2 changes: 2 additions & 0 deletions stock_warehouse_flow/readme/USAGE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
When a stock move is confirmed, if a flow is matching all the criteria
then the new delivery route will be automatically applied.
2 changes: 0 additions & 2 deletions stock_warehouse_flow/readme/USAGE.rst

This file was deleted.

50 changes: 26 additions & 24 deletions stock_warehouse_flow/static/description/index.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<?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>
Expand Down Expand Up @@ -368,23 +369,23 @@ <h1 class="title">Stock Warehouse Flow</h1>
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:e6b0c95d50cd99f1b0d53c1d3a68163d86befc2775d968185c538d7815ceced3
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<p><a class="reference external image-reference" 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 image-reference" 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 image-reference" href="https://github.com/OCA/wms/tree/16.0/stock_warehouse_flow"><img alt="OCA/wms" src="https://img.shields.io/badge/github-OCA%2Fwms-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/wms-16-0/wms-16-0-stock_warehouse_flow"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/wms&amp;target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
<p><a class="reference external image-reference" 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 image-reference" 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 image-reference" href="https://github.com/OCA/wms/tree/17.0/stock_warehouse_flow"><img alt="OCA/wms" src="https://img.shields.io/badge/github-OCA%2Fwms-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/wms-17-0/wms-17-0-stock_warehouse_flow"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/wms&amp;target_branch=17.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
<p>This module introduces the concept of routing flows in order to manage
different delivery routes for a warehouse.</p>
<p>The default behavior of Odoo allows you to have only one delivery route per
warehouse (with one, two or three steps).
With this module, you are now able to manage multiple delivery routes (having
their own rules and operation types), the right one being selected automatically
based on some criterias, like the carrier and any attribute of the stock move
to process.</p>
<p>This allows you to define a delivery route based on the type of goods to ship,
for instance:</p>
<p>The default behavior of Odoo allows you to have only one delivery route
per warehouse (with one, two or three steps). With this module, you are
now able to manage multiple delivery routes (having their own rules and
operation types), the right one being selected automatically based on
some criterias, like the carrier and any attribute of the stock move to
process.</p>
<p>This allows you to define a delivery route based on the type of goods to
ship, for instance:</p>
<ul class="simple">
<li>whole pallet (pick + ship)</li>
<li>cold chain goods</li>
<li>dangerous goods</li>
</ul>
<img alt="https://raw.githubusercontent.com/OCA/wms/14.0/stock_warehouse_flow/static/description/flow.png" src="https://raw.githubusercontent.com/OCA/wms/14.0/stock_warehouse_flow/static/description/flow.png" />
<p><img alt="image_description" src="https://raw.githubusercontent.com/OCA/wms/14.0/stock_warehouse_flow/static/description/flow.png" /></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.
Expand All @@ -409,37 +410,38 @@ <h1 class="title">Stock Warehouse Flow</h1>
<div class="section" id="configuration">
<h1><a class="toc-backref" href="#toc-entry-1">Configuration</a></h1>
<p>Got to “Inventory &gt; Settings &gt; Routing Flows”.</p>
<p>A routing flow can be seen as a helper to generate a delivery route (like the
warehouse is doing automatically). The new route will get its own rules and
operation types that doesn’t overlap with the default ones of the warehouse.</p>
<p>A routing flow is responsible to change the warehouse delivery route of a move
by another one depending on some criterias:</p>
<p>A routing flow can be seen as a helper to generate a delivery route
(like the warehouse is doing automatically). The new route will get its
own rules and operation types that doesn’t overlap with the default ones
of the warehouse.</p>
<p>A routing flow is responsible to change the warehouse delivery route of
a move by another one depending on some criterias:</p>
<ul class="simple">
<li>the initial outgoing operation type (usually the default one)</li>
<li>the carrier</li>
<li>a custom domain (applied on the move)</li>
</ul>
<p>This way you are able to change the route a move will take depending on its
carrier and, for instance, the type or the packaging of the product
<p>This way you are able to change the route a move will take depending on
its carrier and, for instance, the type or the packaging of the product
you want to ship.</p>
<img alt="https://raw.githubusercontent.com/OCA/wms/14.0/stock_warehouse_flow/static/description/config.png" src="https://raw.githubusercontent.com/OCA/wms/14.0/stock_warehouse_flow/static/description/config.png" />
<p><img alt="image" src="https://raw.githubusercontent.com/OCA/wms/14.0/stock_warehouse_flow/static/description/config.png" /></p>
</div>
<div class="section" id="usage">
<h1><a class="toc-backref" href="#toc-entry-2">Usage</a></h1>
<p>When a stock move is confirmed, if a flow is matching all the criteria then
the new delivery route will be automatically applied.</p>
<p>When a stock move is confirmed, if a flow is matching all the criteria
then the new delivery route will be automatically applied.</p>
</div>
<div class="section" id="known-issues-roadmap">
<h1><a class="toc-backref" href="#toc-entry-3">Known issues / Roadmap</a></h1>
<p>Currently, the module supports only delivery routes, but it could improved to
support reception routes as well.</p>
<p>Currently, the module supports only delivery routes, but it could
improved to support reception routes as well.</p>
</div>
<div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#toc-entry-4">Bug Tracker</a></h1>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/wms/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 to smash it by providing a detailed and welcomed
<a class="reference external" href="https://github.com/OCA/wms/issues/new?body=module:%20stock_warehouse_flow%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<a class="reference external" href="https://github.com/OCA/wms/issues/new?body=module:%20stock_warehouse_flow%0Aversion:%2017.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">
Expand All @@ -466,7 +468,7 @@ <h2><a class="toc-backref" href="#toc-entry-8">Maintainers</a></h2>
<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/wms/tree/16.0/stock_warehouse_flow">OCA/wms</a> project on GitHub.</p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/wms/tree/17.0/stock_warehouse_flow">OCA/wms</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>
Expand Down
Loading

0 comments on commit aac5b7a

Please sign in to comment.