Metadata-Version: 2.1
Name: odoo-addon-shipment_advice_planner_toursolver
Version: 16.0.3.2.0
Summary: Shipment advices planning by geo-optimization (TourSolver)
Home-page: https://github.com/OCA/stock-logistics-transport
Author: ACSONE SA/NV,Odoo Community Association (OCA)
Author-email: support@odoo-community.org
License: AGPL-3
Classifier: Programming Language :: Python
Classifier: Framework :: Odoo
Classifier: Framework :: Odoo :: 16.0
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Requires-Python: >=3.10
Requires-Dist: odoo-addon-base-time-window<16.1dev,>=16.0dev
Requires-Dist: odoo-addon-shipment-advice-planner<16.1dev,>=16.0dev
Requires-Dist: odoo<16.1dev,>=16.0a

.. image:: https://odoo-community.org/readme-banner-image
   :target: https://odoo-community.org/get-involved?utm_source=readme
   :alt: Odoo Community Association

==================================
Shipment Advice Planner Toursolver
==================================

.. 
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! This file is generated by oca-gen-addon-readme !!
   !! changes will be overwritten.                   !!
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! source digest: sha256:e88815d04e5704cef012ac21a87662f2a364b6fd4f31b118882355302e3b9ee4
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |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/license-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%2Fstock--logistics--transport-lightgray.png?logo=github
    :target: https://github.com/OCA/stock-logistics-transport/tree/16.0/shipment_advice_planner_toursolver
    :alt: OCA/stock-logistics-transport
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/stock-logistics-transport-16-0/stock-logistics-transport-16-0-shipment_advice_planner_toursolver
    :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/stock-logistics-transport&target_branch=16.0
    :alt: Try me on Runboat

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

This module extend the shipment advice planner engine to add a new planning
method based on geo-localization. It uses the GEOCONCEPT solution called
TourSolver to plan the shipment advices according to the location of the customers
by calculating the best route according to the available resources.

**Table of contents**

.. contents::
   :local:

Configuration
=============

Before configuring this module, you must configure your account and your
resources on the TourSolver website. Then you should be able to get your api key
and paste it in the default backend. You can access to backends list under the
setting menu of the inventory module.

The second step is to create the resources. You can add the properties you want
TourSolver to use in its calculation of the best route.

For advanced planning, you can define your customer delivery windows. It will be
considered in TourSolver calculation.

For more details about the properties you can use, please consult
[TourSolver documentation](https://mygeoconcept.com/doc/6cc656Uv7gARvG6T/ts-cloud-doc/docs/en/toursolver-cloud-book/)

Usage
=====

In the shipment planner you will see a new option added to the planning methods.
If you select TourSolver, a TourSolver task per warehouse will be created for
the pickings you want to plan.

The task will pass through different states by a dedicated cron and at the end
of the process will create shipment advices according the returned result from
TourSolver.

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

At this stage, the TourSolver task is managed by a cron which will synchronize
its status with TourSolver and get the result when it is ready.
Another approach is available using queue jobs where the sync task will be
rescheduled until it gets the optimization result.

Ideally, a webhook can be developed to be notified by toursolver when the result
is ready. He will ensure that the result is obtained as soon as possible.

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

Bugs are tracked on `GitHub Issues <https://github.com/OCA/stock-logistics-transport/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/stock-logistics-transport/issues/new?body=module:%20shipment_advice_planner_toursolver%0Aversion:%2016.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
~~~~~~~

* ACSONE SA/NV

Contributors
~~~~~~~~~~~~

* Laurent Mignon <laurent.mignon@acsone.eu>
* Souheil Bejaoui <souheil.bejaoui@acsone.eu>

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/stock-logistics-transport <https://github.com/OCA/stock-logistics-transport/tree/16.0/shipment_advice_planner_toursolver>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
