odoo-driver 0.9.6__tar.gz

odoo_driver-0.9.6/PKG-INFO

@@ -0,0 +1,306 @@
+Metadata-Version: 2.1
+Name: odoo-driver
+Version: 0.9.6
+Summary:     Python library to communicates with devices used by Odoo.(Mainly Point of Sale application)Alternative to Iot Box Odoo solution or Pywebdriver community solution.
+Home-page: https://gitlab.com/grap-rhone-alpes/odoo-driver
+Keywords: Odoo,Point Of Sale,Driver
+Author: Sylvain LE GAL
+Author-email: sylvain.legal@grap.coop
+Maintainer: Sylvain LE GAL
+Maintainer-email: sylvain.legal@grap.coop
+Requires-Python: >=3.9,<4.0.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Odoo
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: GNU Affero General Public License v3
+Classifier: Operating System :: Unix
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: click-loglevel (>=0.5.0,<0.6.0)
+Requires-Dist: flask (>=3.0.3,<4.0.0)
+Requires-Dist: flask-babel (>=4.0.0,<5.0.0)
+Requires-Dist: flask-cors (>=4.0.1,<5.0.0)
+Requires-Dist: gevent (>=24.2.1,<25.0.0)
+Requires-Dist: gevent-websocket (>=0.10.1,<0.11.0)
+Requires-Dist: importlib-resources (>=6.4.0,<7.0.0)
+Requires-Dist: loguru (>=0.7.2,<0.8.0)
+Requires-Dist: psutil (>=6.0.0,<7.0.0)
+Requires-Dist: pyserial (>=3.5,<4.0)
+Requires-Dist: pyteliummanager (>=2.4.2,<3.0.0)
+Requires-Dist: python-escpos (>=3.1,<4.0)
+Requires-Dist: python-statemachine (>=2.3.4,<3.0.0)
+Requires-Dist: pyusb (>=1.2.1,<2.0.0)
+Requires-Dist: simplejson (>=3.19.3,<4.0.0)
+Requires-Dist: single-source (>=0.4.0,<0.5.0)
+Requires-Dist: unidecode (>=1.3.8,<2.0.0)
+Project-URL: Repository, https://gitlab.com/grap-rhone-alpes/odoo-driver
+Description-Content-Type: text/markdown
+
+![License: AGPL v3](https://img.shields.io/badge/License-AGPL_v3-blue.svg)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/odoo-driver)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/odoo-driver)
+![GitLab last commit](https://img.shields.io/gitlab/last-commit/60778766)
+![GitLab stars](https://img.shields.io/gitlab/stars/60778766?style=social)
+[![Socket Badge](https://socket.dev/api/badge/pypi/package/odoo-driver)](https://socket.dev/pypi/package/odoo-driver)
+
+# Odoo POS Driver
+
+This tools is intented to be used with the Odoo Point of sale application. It replaces the Odoo [IoT Box](https://www.odoo.com/app/iot) or the
+Community [pywebdriver](https://github.com/pywebdriver/pywebdriver) library.
+
+Once installed locally in the cashier computer, devices will be discovered by the tool,
+once plugged, and communication can be done with the Odoo Point of Sale module.
+
+# Table of contents
+
+1. [Run](#run)
+2. [Usage](#usage)
+3. [Installation](#installation)
+4. [Related Odoo Modules](#related-odoo-modules)
+5. [Compatible Devices](#compatible-devices)
+6. [How to Contribute](#how-to-contribute)
+7. [Development](#development)
+7. [Roadmap and Known Issues](#roadmap-and-known-issues)
+8. [Credits](#credits)
+
+## <div id="run">Run</div>
+
+```shell
+odoo-driver\
+  --address 0.0.0.0\
+  --port 8069\
+  --secure\
+  --refresh-devices-delay 1\
+  --log-level INFO\
+  --log-folder false\
+  --options EXTRA_OPTIONS
+```
+
+(The values displayed above are the default values.
+
+* ``-a / --address``: address where the web service will be available
+
+* ``-p / --port``: port where the web service will be available
+
+* ``--secure/--unsecure``: expose webservice with https
+  (or http, if ``--unsecure`` is selected).
+
+* ``-r / --refresh-devices-delay``: interval in seconds
+  between two checks of devices connected to usb ports.
+
+* ``-l / --log-level``: Possible values:
+  ``TRACE`` / ``DEBUG`` / ``INFO`` / ``SUCCESS`` /
+  ``WARNING`` / ``ERROR`` / ``CRITICAL``.
+  Note:
+  - ``TRACE`` will log all the http call.
+  - ``DEBUG`` will log all the data received, including images received by the
+    printer device.
+  - Use ``INFO`` level or higher in production outside a debugging situation.
+
+* ``-f / --log-folder``: Optional directory that will contains logs.
+  If defined, it should exist and be writable.
+
+* ``--options``: Json formatted data to pass to devices. Ex:
+  ``'{"scale": {"polynomial": 123456}}'``
+  That will pass the polynomial value to the scale device.
+  Note: don't forget the simple quote at the beginning and the end of the
+  dictionnary.
+
+## <div id="usage">Usage</div>
+
+Go the home page of the tool, via https://localhost:8069.
+
+If you choose https deployment, you should accept the first time
+a security exception in your browser.
+
+![security_exception](https://gitlab.com/grap-rhone-alpes/odoo-driver/-/raw/main/odoo_driver/static/readme/security_exception.png)
+
+
+Pages are available to test connections, see errors, etc.
+
+![home_page](https://gitlab.com/grap-rhone-alpes/odoo-driver/-/raw/main/odoo_driver/static/readme/home_page.png)
+
+## <div id="installation">Installation</div>
+
+### Installation (to run it manually)
+
+* install the latest released version:
+
+```shell
+pipx install odoo-driver
+```
+
+* _or_ Install the latest version:
+
+```shell
+pipx install git+https://gitlab.com/grap-rhone-alpes/odoo-driver.git
+```
+
+Note: use ``--python python3.9`` (or higher) option, if your default python environment is under python 3.9 version.
+
+### Installation (as a service)
+
+This will create a service (via systemd) that will execute odoo-driver in the background and launches at startup.
+
+```shell
+wget https://gitlab.com/grap-rhone-alpes/odoo-driver/-/raw/main/install_debian.sh
+# (OPTIONAL) adapt the installation script before execution
+# adding specific argument in the call of odoo-driver in the .service file
+sudo sh install_debian.sh
+```
+
+Once installed, you can run the following system command.
+
+```shell
+# Get status of the service
+sudo systemctl status odoo-driver.service
+
+# Follow the logs of the service
+sudo journalctl -fu odoo-driver.service
+```
+
+## <div id="related-odoo-modules">Related Odoo Modules</div>
+
+Compatibility of the library with Odoo Modules, depending on the version.
+
+### V16
+
+- Printer (+ Cashbox): ``point_of_sale`` (Odoo CE)
+
+- Display: [``pos_odoo_driver_display``](https://github.com/grap/odoo-addons-pos)
+
+- Payment: [``pos_odoo_driver_payment``](https://github.com/grap/odoo-addons-pos)
+
+- Scale: ``point_of_sale`` (Odoo CE)
+
+## <div id="compatible-devices">Compatible Devices</div>
+
+<table style="width: 100%;">
+    <tbody>
+        <tr>
+            <th colspan="2"><h3>Printers</h3></th>
+        </tr>
+        <tr>
+            <td>
+              <li>
+                Epson - TM-T20II<br/>
+                Epson - TM-T20III
+              </li>
+            </td>
+            <td>
+              <img src="https://gitlab.com/grap-rhone-alpes/odoo-driver/-/raw/main/odoo_driver/static/devices/printer__epson__tm_t20.png" width="200" height="200" />
+            </td>
+        </tr>
+        <tr>
+            <th colspan="2"><h3>Display</h3></th>
+        </tr>
+        <tr>
+            <td>Aures - OCD 300</td>
+            <td>
+              <img src="https://gitlab.com/grap-rhone-alpes/odoo-driver/-/raw/main/odoo_driver/static/devices/display__aures__ocd_300.png" width="200" height="200" />
+            </td>
+        </tr>
+        <tr>
+            <th colspan="2"><h3>Payment Terminal</h3></th>
+        </tr>
+        <tr>
+            <td>Ingenico - Move/5000</td>
+            <td>
+              <img src="https://gitlab.com/grap-rhone-alpes/odoo-driver/-/raw/main/odoo_driver/static/devices/payment__ingenico__move_5000.png" width="200" height="200" />
+            </td>
+        </tr>
+        <tr>
+            <th colspan="2"><h3>Scale</h3></th>
+        </tr>
+        <tr>
+            <td>Mettler Toledo - Ariva S</td>
+            <td>
+              <img src="https://gitlab.com/grap-rhone-alpes/odoo-driver/-/raw/main/odoo_driver/static/devices/scale__mettler_toledo__ariva_s.png" width="200" height="200" />
+            </td>
+        </tr>
+    </tbody>
+</table>
+
+## <div id="how-to-contribute">How to Contribute</div>
+
+### Welcome contributions
+
+* If the project is not translated into your language,
+  you can propose a translation.
+
+* If you've encountered a problem or bug that you've solved,
+  the patch will be very welcome !
+
+### Unwelcome contributions
+
+Please **do not propose** a Merge Request before opening first an issue on gitlab,
+if you want to add new feature, new devices, etc.
+
+Maintaining a driver library is an impossible task if you don't own the device.
+If the device or the feature you propose is not in the Roadmap of the GRAP company,
+it will be refused, to avoid rising technical debt.
+
+In that case, do not hesitate to fork the project, to implement your change
+in a dedicated branch.
+
+## <div id="development">Development</div>
+
+See the dedicated section [here](https://gitlab.com/grap-rhone-alpes/odoo-driver/-/blob/main/DEVELOP.md).
+
+## <div id="roadmap-and-known-issues">Roadmap and Known Issues</div>
+
+See the dedicated section [here](https://gitlab.com/grap-rhone-alpes/odoo-driver/-/blob/main/ROADMAP.md).
+
+## <div id="credits">Credits</div>
+
+### Authors
+
+* GRAP <https://www.grap.coop>
+
+### Contributors
+
+* Sylvain LE GAL <sylvain.legal@grap.coop>
+
+### Extra authorship
+
+Part of the code in this project comes from the following projects, including:
+
+  * [Pywebdriver](https://github.com/pywebdriver/pywebdriver) (AGPL-3.0), by GRAP. Main contributors are:
+
+    * Sylvain LE GAL <sylvain.legal@grap.coop>
+    * Sylvain CALADOR <sylvain.calador@akretion.com>
+    * Sébastien BEAU <sebastien.beau@akretion.com>
+    * Carmen BIANCA BAKKER <carmen@coopiteasy.be>
+    * Alexis DE LATTRE <alexis.delattre@akretion.com>
+    * Quentin DUPONT <quentin.dupont@grap.coop>
+    * Pierrick BRUN <pierrick.brun@akretion.com>
+    * Hugues DE KEYZER  <hugues@coopiteasy.be>
+
+  * [hw_dialog06_scale](https://github.com/coopiteasy/iot/tree/12.0-dialog06/hw_dialog06_scale) (AGPL-3.0), by Coop It Easy. Main contributors are:
+
+    * Vincent Van Rossem <vincent.vanrossem@camptocamp.com>
+
+  * [pyposdisplay](https://github.com/akretion/pyposdisplay) (AGPL-3.0), by Akretion. Main contributors are:
+
+    * Alexis DE LATTRE <alexis.delattre@akretion.com>
+    * Sébastien BEAU <sebastien.beau@akretion.com>
+
+The following projects were also useful and were studied to realize this library.
+
+  * [Odoo](https://github.com/odoo/odoo) (AGPL-3.0 up to version 8.0, and then LGPL-3.0 from version 9.0 onwards), by Odoo SA, specially "hw_" modules.
+
+### Images
+
+* [Main Application icon](https://www.flaticon.com/fr/icones-gratuites/hub-usb), by AbtoCreative (Flaticon).
+
+* [Credit Card Payment Terminal Icon](https://www.flaticon.com/fr/icone-gratuite/terminal-de-paiement_6137350), created by ToZ Icon (Flaticon).
+
+* [LCD Customer Display Icon](https://www.flaticon.com/fr/icone-gratuite/lcd_9622586), created by Iconic Panda (Flaticon).
+
+* [Thermal Receipt Printer Icon](https://www.flaticon.com/fr/icone-gratuite/facture_1649343), created by Icongeek26 (Flaticon).
+
+* [Scale Icon](https://www.flaticon.com/fr/icone-gratuite/pesee_1104592), created by itim2101 (Flaticon).
+

odoo_driver-0.9.6/README.md

@@ -0,0 +1,264 @@
+![License: AGPL v3](https://img.shields.io/badge/License-AGPL_v3-blue.svg)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/odoo-driver)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/odoo-driver)
+![GitLab last commit](https://img.shields.io/gitlab/last-commit/60778766)
+![GitLab stars](https://img.shields.io/gitlab/stars/60778766?style=social)
+[![Socket Badge](https://socket.dev/api/badge/pypi/package/odoo-driver)](https://socket.dev/pypi/package/odoo-driver)
+
+# Odoo POS Driver
+
+This tools is intented to be used with the Odoo Point of sale application. It replaces the Odoo [IoT Box](https://www.odoo.com/app/iot) or the
+Community [pywebdriver](https://github.com/pywebdriver/pywebdriver) library.
+
+Once installed locally in the cashier computer, devices will be discovered by the tool,
+once plugged, and communication can be done with the Odoo Point of Sale module.
+
+# Table of contents
+
+1. [Run](#run)
+2. [Usage](#usage)
+3. [Installation](#installation)
+4. [Related Odoo Modules](#related-odoo-modules)
+5. [Compatible Devices](#compatible-devices)
+6. [How to Contribute](#how-to-contribute)
+7. [Development](#development)
+7. [Roadmap and Known Issues](#roadmap-and-known-issues)
+8. [Credits](#credits)
+
+## <div id="run">Run</div>
+
+```shell
+odoo-driver\
+  --address 0.0.0.0\
+  --port 8069\
+  --secure\
+  --refresh-devices-delay 1\
+  --log-level INFO\
+  --log-folder false\
+  --options EXTRA_OPTIONS
+```
+
+(The values displayed above are the default values.
+
+* ``-a / --address``: address where the web service will be available
+
+* ``-p / --port``: port where the web service will be available
+
+* ``--secure/--unsecure``: expose webservice with https
+  (or http, if ``--unsecure`` is selected).
+
+* ``-r / --refresh-devices-delay``: interval in seconds
+  between two checks of devices connected to usb ports.
+
+* ``-l / --log-level``: Possible values:
+  ``TRACE`` / ``DEBUG`` / ``INFO`` / ``SUCCESS`` /
+  ``WARNING`` / ``ERROR`` / ``CRITICAL``.
+  Note:
+  - ``TRACE`` will log all the http call.
+  - ``DEBUG`` will log all the data received, including images received by the
+    printer device.
+  - Use ``INFO`` level or higher in production outside a debugging situation.
+
+* ``-f / --log-folder``: Optional directory that will contains logs.
+  If defined, it should exist and be writable.
+
+* ``--options``: Json formatted data to pass to devices. Ex:
+  ``'{"scale": {"polynomial": 123456}}'``
+  That will pass the polynomial value to the scale device.
+  Note: don't forget the simple quote at the beginning and the end of the
+  dictionnary.
+
+## <div id="usage">Usage</div>
+
+Go the home page of the tool, via https://localhost:8069.
+
+If you choose https deployment, you should accept the first time
+a security exception in your browser.
+
+![security_exception](https://gitlab.com/grap-rhone-alpes/odoo-driver/-/raw/main/odoo_driver/static/readme/security_exception.png)
+
+
+Pages are available to test connections, see errors, etc.
+
+![home_page](https://gitlab.com/grap-rhone-alpes/odoo-driver/-/raw/main/odoo_driver/static/readme/home_page.png)
+
+## <div id="installation">Installation</div>
+
+### Installation (to run it manually)
+
+* install the latest released version:
+
+```shell
+pipx install odoo-driver
+```
+
+* _or_ Install the latest version:
+
+```shell
+pipx install git+https://gitlab.com/grap-rhone-alpes/odoo-driver.git
+```
+
+Note: use ``--python python3.9`` (or higher) option, if your default python environment is under python 3.9 version.
+
+### Installation (as a service)
+
+This will create a service (via systemd) that will execute odoo-driver in the background and launches at startup.
+
+```shell
+wget https://gitlab.com/grap-rhone-alpes/odoo-driver/-/raw/main/install_debian.sh
+# (OPTIONAL) adapt the installation script before execution
+# adding specific argument in the call of odoo-driver in the .service file
+sudo sh install_debian.sh
+```
+
+Once installed, you can run the following system command.
+
+```shell
+# Get status of the service
+sudo systemctl status odoo-driver.service
+
+# Follow the logs of the service
+sudo journalctl -fu odoo-driver.service
+```
+
+## <div id="related-odoo-modules">Related Odoo Modules</div>
+
+Compatibility of the library with Odoo Modules, depending on the version.
+
+### V16
+
+- Printer (+ Cashbox): ``point_of_sale`` (Odoo CE)
+
+- Display: [``pos_odoo_driver_display``](https://github.com/grap/odoo-addons-pos)
+
+- Payment: [``pos_odoo_driver_payment``](https://github.com/grap/odoo-addons-pos)
+
+- Scale: ``point_of_sale`` (Odoo CE)
+
+## <div id="compatible-devices">Compatible Devices</div>
+
+<table style="width: 100%;">
+    <tbody>
+        <tr>
+            <th colspan="2"><h3>Printers</h3></th>
+        </tr>
+        <tr>
+            <td>
+              <li>
+                Epson - TM-T20II<br/>
+                Epson - TM-T20III
+              </li>
+            </td>
+            <td>
+              <img src="https://gitlab.com/grap-rhone-alpes/odoo-driver/-/raw/main/odoo_driver/static/devices/printer__epson__tm_t20.png" width="200" height="200" />
+            </td>
+        </tr>
+        <tr>
+            <th colspan="2"><h3>Display</h3></th>
+        </tr>
+        <tr>
+            <td>Aures - OCD 300</td>
+            <td>
+              <img src="https://gitlab.com/grap-rhone-alpes/odoo-driver/-/raw/main/odoo_driver/static/devices/display__aures__ocd_300.png" width="200" height="200" />
+            </td>
+        </tr>
+        <tr>
+            <th colspan="2"><h3>Payment Terminal</h3></th>
+        </tr>
+        <tr>
+            <td>Ingenico - Move/5000</td>
+            <td>
+              <img src="https://gitlab.com/grap-rhone-alpes/odoo-driver/-/raw/main/odoo_driver/static/devices/payment__ingenico__move_5000.png" width="200" height="200" />
+            </td>
+        </tr>
+        <tr>
+            <th colspan="2"><h3>Scale</h3></th>
+        </tr>
+        <tr>
+            <td>Mettler Toledo - Ariva S</td>
+            <td>
+              <img src="https://gitlab.com/grap-rhone-alpes/odoo-driver/-/raw/main/odoo_driver/static/devices/scale__mettler_toledo__ariva_s.png" width="200" height="200" />
+            </td>
+        </tr>
+    </tbody>
+</table>
+
+## <div id="how-to-contribute">How to Contribute</div>
+
+### Welcome contributions
+
+* If the project is not translated into your language,
+  you can propose a translation.
+
+* If you've encountered a problem or bug that you've solved,
+  the patch will be very welcome !
+
+### Unwelcome contributions
+
+Please **do not propose** a Merge Request before opening first an issue on gitlab,
+if you want to add new feature, new devices, etc.
+
+Maintaining a driver library is an impossible task if you don't own the device.
+If the device or the feature you propose is not in the Roadmap of the GRAP company,
+it will be refused, to avoid rising technical debt.
+
+In that case, do not hesitate to fork the project, to implement your change
+in a dedicated branch.
+
+## <div id="development">Development</div>
+
+See the dedicated section [here](https://gitlab.com/grap-rhone-alpes/odoo-driver/-/blob/main/DEVELOP.md).
+
+## <div id="roadmap-and-known-issues">Roadmap and Known Issues</div>
+
+See the dedicated section [here](https://gitlab.com/grap-rhone-alpes/odoo-driver/-/blob/main/ROADMAP.md).
+
+## <div id="credits">Credits</div>
+
+### Authors
+
+* GRAP <https://www.grap.coop>
+
+### Contributors
+
+* Sylvain LE GAL <sylvain.legal@grap.coop>
+
+### Extra authorship
+
+Part of the code in this project comes from the following projects, including:
+
+  * [Pywebdriver](https://github.com/pywebdriver/pywebdriver) (AGPL-3.0), by GRAP. Main contributors are:
+
+    * Sylvain LE GAL <sylvain.legal@grap.coop>
+    * Sylvain CALADOR <sylvain.calador@akretion.com>
+    * Sébastien BEAU <sebastien.beau@akretion.com>
+    * Carmen BIANCA BAKKER <carmen@coopiteasy.be>
+    * Alexis DE LATTRE <alexis.delattre@akretion.com>
+    * Quentin DUPONT <quentin.dupont@grap.coop>
+    * Pierrick BRUN <pierrick.brun@akretion.com>
+    * Hugues DE KEYZER  <hugues@coopiteasy.be>
+
+  * [hw_dialog06_scale](https://github.com/coopiteasy/iot/tree/12.0-dialog06/hw_dialog06_scale) (AGPL-3.0), by Coop It Easy. Main contributors are:
+
+    * Vincent Van Rossem <vincent.vanrossem@camptocamp.com>
+
+  * [pyposdisplay](https://github.com/akretion/pyposdisplay) (AGPL-3.0), by Akretion. Main contributors are:
+
+    * Alexis DE LATTRE <alexis.delattre@akretion.com>
+    * Sébastien BEAU <sebastien.beau@akretion.com>
+
+The following projects were also useful and were studied to realize this library.
+
+  * [Odoo](https://github.com/odoo/odoo) (AGPL-3.0 up to version 8.0, and then LGPL-3.0 from version 9.0 onwards), by Odoo SA, specially "hw_" modules.
+
+### Images
+
+* [Main Application icon](https://www.flaticon.com/fr/icones-gratuites/hub-usb), by AbtoCreative (Flaticon).
+
+* [Credit Card Payment Terminal Icon](https://www.flaticon.com/fr/icone-gratuite/terminal-de-paiement_6137350), created by ToZ Icon (Flaticon).
+
+* [LCD Customer Display Icon](https://www.flaticon.com/fr/icone-gratuite/lcd_9622586), created by Iconic Panda (Flaticon).
+
+* [Thermal Receipt Printer Icon](https://www.flaticon.com/fr/icone-gratuite/facture_1649343), created by Icongeek26 (Flaticon).
+
+* [Scale Icon](https://www.flaticon.com/fr/icone-gratuite/pesee_1104592), created by itim2101 (Flaticon).

odoo_driver-0.9.6/odoo_driver/__init__.py

@@ -0,0 +1,5 @@
+from pathlib import Path
+
+from single_source import get_version
+
+__version__ = get_version(__name__, Path(__file__).parent.parent)

odoo_driver-0.9.6/odoo_driver/app.py

@@ -0,0 +1,29 @@
+from flask import Flask, request
+from flask_babel import Babel
+from flask_cors import CORS
+
+# Initialize Flask Application
+app = Flask(__name__)
+
+# Include extra route files
+from . import flask_app  # noqa: F401,E402
+
+# Handle CORS call
+CORS(app, resources={r"/*": {"origins": "*"}})
+
+# Handle translation via babel
+app.config["BABEL_DEFAULT_LOCALE"] = "en"
+babel = Babel(app)
+
+
+def get_locale():
+    # Use the browser's language preferences to select an available translation
+    available_translations = [
+        str(translation) for translation in babel.list_translations()
+    ]
+    for lang in request.accept_languages.values():
+        if lang[:2] in available_translations:
+            return lang[:2]
+
+
+babel.init_app(app, locale_selector=get_locale)