Add development status, readme, pip files

setup/stock_vertical_lift/odoo/addons/stock_vertical_lift

@@ -0,0 +1 @@
+../../../../stock_vertical_lift

setup/stock_vertical_lift/setup.py

@@ -0,0 +1,6 @@
+import setuptools
+
+setuptools.setup(
+    setup_requires=['setuptools-odoo'],
+    odoo_addon=True,
+)

setup/stock_vertical_lift_kardex/odoo/addons/stock_vertical_lift_kardex

@@ -0,0 +1 @@
+../../../../stock_vertical_lift_kardex

setup/stock_vertical_lift_kardex/setup.py

@@ -0,0 +1,6 @@
+import setuptools
+
+setuptools.setup(
+    setup_requires=['setuptools-odoo'],
+    odoo_addon=True,
+)

stock_vertical_lift/README.rst

@@ -0,0 +1,134 @@
+=============
+Vertical Lift
+=============
+
+.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |badge1| image:: https://img.shields.io/badge/maturity-Alpha-red.png
+    :target: https://odoo-community.org/page/development-status
+    :alt: Alpha
+.. |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%2Fstock--logistics--warehouse-lightgray.png?logo=github
+    :target: https://github.com/OCA/stock-logistics-warehouse/tree/12.0/stock_vertical_lift
+    :alt: OCA/stock-logistics-warehouse
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/stock-logistics-warehouse-12-0/stock-logistics-warehouse-12-0-stock_vertical_lift
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
+    :target: https://runbot.odoo-community.org/runbot/153/12.0
+    :alt: Try me on Runbot
+
+|badge1| |badge2| |badge3| |badge4| |badge5| 
+
+Add configuration and dedicated screens to work with Vertical Lift
+systems (such as Kardex Remstar, Modula, ...). Drivers for controlling
+the lifts physically must be added by additional addons.
+
+.. 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://github.com/OCA/odoo-community.org/blob/master/website/Contribution/oca_module_lifecycle_development_status.rst>`_
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Configuration
+=============
+
+General
+~~~~~~~
+
+In Inventory Settings, you must have:
+
+ * Storage Locations
+ * Multi-Warehouses
+ * Multi-Step Routes
+
+Locations
+~~~~~~~~~
+
+Additional configuration parameters are added in Locations:
+
+* Sub-locations of a location with the "Is a Vertical Lift View Location"
+  activated are considered as "Shuttles". A shuttle is a vertical lift shelf.
+* Sub-locations of shuttles are considered as "Trays", which is a tier of a
+  shuttle. When a tray is created, a tray type must be selected. When saved, the
+  tray location will automatically create as many sub-locations - called
+  "Cells" - as the tray type contains.
+* The tray type of a tray can be changed as long as none of its cell contains
+  products. When changed, it archives the cells and creates new ones as
+  configured on the new tray type.
+
+Tray types
+~~~~~~~~~~
+
+Tray types can be configured in the Inventory settings.
+A tray type defines how much cells a tray can hold. It is a square or rectangle
+matrix of n cols * m rows.
+
+Vertical Lift Shuttles
+~~~~~~~~~~~~~~~~~~~~~~
+
+The Shuttles are the Vertical Lift Trays. One Shuttle entity has to be created
+in Odoo for each physical shuttle. Depending of the subsidiary addons installed
+(eg. Kardex), different options may be required (host address, ...). The base
+addon only includes shuttles of kind "simulation" which will not send orders to
+the hardware.
+
+Known issues / Roadmap
+======================
+
+* Extract the tray types and matrix widget in a module, they can be used
+  alone without vertical lift
+* Consider merging the 'vertical_lift_kind' with the kind added by
+  stock_location_zone
+* Complete Pick screen and workflow (currently enough for a demo, not for production)
+* Implement Put-away screen and workflow
+* Implement Inventory screen and workflow
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/stock-logistics-warehouse/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/stock-logistics-warehouse/issues/new?body=module:%20stock_vertical_lift%0Aversion:%2012.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
+
+Contributors
+~~~~~~~~~~~~
+
+* Guewen Baconnier <[email protected]>
+
+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-warehouse <https://github.com/OCA/stock-logistics-warehouse/tree/12.0/stock_vertical_lift>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

stock_vertical_lift/__manifest__.py

@@ -33,4 +33,5 @@
         'security/ir.model.access.csv',
     ],
     'installable': True,
+    'development_status': 'Alpha',
 }

stock_vertical_lift/models/vertical_lift_shuttle.py

@@ -302,6 +302,8 @@ def select_next_move_line(self):
             self._domain_move_lines_to_do(), limit=1
         )
         self.current_move_line_id = next_move_line
+        # TODO use a state machine to define next steps and
+        # description?
         descr = (
             _('Scan New Destination Location')
             if next_move_line

stock_vertical_lift/readme/CONFIGURE.rst

@@ -0,0 +1,39 @@
+General
+~~~~~~~
+
+In Inventory Settings, you must have:
+
+ * Storage Locations
+ * Multi-Warehouses
+ * Multi-Step Routes
+
+Locations
+~~~~~~~~~
+
+Additional configuration parameters are added in Locations:
+
+* Sub-locations of a location with the "Is a Vertical Lift View Location"
+  activated are considered as "Shuttles". A shuttle is a vertical lift shelf.
+* Sub-locations of shuttles are considered as "Trays", which is a tier of a
+  shuttle. When a tray is created, a tray type must be selected. When saved, the
+  tray location will automatically create as many sub-locations - called
+  "Cells" - as the tray type contains.
+* The tray type of a tray can be changed as long as none of its cell contains
+  products. When changed, it archives the cells and creates new ones as
+  configured on the new tray type.
+
+Tray types
+~~~~~~~~~~
+
+Tray types can be configured in the Inventory settings.
+A tray type defines how much cells a tray can hold. It is a square or rectangle
+matrix of n cols * m rows.
+
+Vertical Lift Shuttles
+~~~~~~~~~~~~~~~~~~~~~~
+
+The Shuttles are the Vertical Lift Trays. One Shuttle entity has to be created
+in Odoo for each physical shuttle. Depending of the subsidiary addons installed
+(eg. Kardex), different options may be required (host address, ...). The base
+addon only includes shuttles of kind "simulation" which will not send orders to
+the hardware.

stock_vertical_lift/readme/CONTRIBUTORS.rst

@@ -0,0 +1 @@
+* Guewen Baconnier <[email protected]>

stock_vertical_lift/readme/DESCRIPTION.rst

@@ -0,0 +1,3 @@
+Add configuration and dedicated screens to work with Vertical Lift
+systems (such as Kardex Remstar, Modula, ...). Drivers for controlling
+the lifts physically must be added by additional addons.

stock_vertical_lift/readme/ROADMAP.rst

@@ -0,0 +1,7 @@
+* Extract the tray types and matrix widget in a module, they can be used
+  alone without vertical lift
+* Consider merging the 'vertical_lift_kind' with the kind added by
+  stock_location_zone
+* Complete Pick screen and workflow (currently enough for a demo, not for production)
+* Implement Put-away screen and workflow
+* Implement Inventory screen and workflow