You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

125 lines
4.5 KiB

  1. .. image:: https://img.shields.io/badge/license-AGPL--3-blue.png
  2. :target: https://www.gnu.org/licenses/agpl
  3. :alt: License: AGPL-3
  4. .. image:: https://gitlab.mukit.at/web/muk_web_utils/badges/12.0/pipeline.svg
  5. :target: https://gitlab.mukit.at/web/muk_web_utils/commits/12.0
  6. :alt: Pipeline status
  7. .. image:: https://gitlab.mukit.at/web/muk_web_utils/badges/12.0/coverage.svg
  8. :target: https://gitlab.mukit.at/web/muk_web_utils/commits/12.0
  9. :alt: Coverage report
  10. =============
  11. MuK Web Utils
  12. =============
  13. Technical module to provide some utility features and libraries that can be used
  14. in other applications. This module has no direct effect on the running system.
  15. Installation
  16. ============
  17. To install this module, you need to:
  18. Download the module and add it to your Odoo addons folder. Afterward, log on to
  19. your Odoo server and go to the Apps menu. Trigger the debug mode and update the
  20. list by clicking on the "Update Apps List" link. Now install the module by
  21. clicking on the install button.
  22. Another way to install this module is via the package management for Python
  23. (`PyPI <https://pypi.org/project/pip/>`_).
  24. To install our modules using the package manager make sure
  25. `odoo-autodiscover <https://pypi.org/project/odoo-autodiscover/>`_ is installed
  26. correctly. Then open a console and install the module by entering the following
  27. command:
  28. ``pip install --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>``
  29. The module name consists of the Odoo version and the module name, where
  30. underscores are replaced by a dash.
  31. **Module:**
  32. ``odoo<version>-addon-<module_name>``
  33. **Example:**
  34. ``sudo -H pip3 install --extra-index-url https://nexus.mukit.at/repository/odoo/simple odoo11-addon-muk-utils``
  35. Once the installation has been successfully completed, the app is already in the
  36. correct folder. Log on to your Odoo server and go to the Apps menu. Trigger the
  37. debug mode and update the list by clicking on the "Update Apps List" link. Now
  38. install the module by clicking on the install button.
  39. The biggest advantage of this variant is that you can now also update the app
  40. using the "pip" command. To do this, enter the following command in your console:
  41. ``pip install --upgrade --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>``
  42. When the process is finished, restart your server and update the application in
  43. Odoo. The steps are the same as for the installation only the button has changed
  44. from "Install" to "Upgrade".
  45. You can also view available Apps directly in our `repository <https://nexus.mukit.at/#browse/browse:odoo>`_
  46. and find a more detailed installation guide on our `website <https://mukit.at/page/open-source>`_.
  47. For modules licensed under OPL-1, you will receive access data when you purchase
  48. the module. If the modules were not purchased directly from
  49. `MuK IT <https://www.mukit.at/>`_ please contact our support (support@mukit.at)
  50. with a confirmation of purchase to receive the corresponding access data.
  51. Upgrade
  52. ============
  53. To upgrade this module, you need to:
  54. Download the module and add it to your Odoo addons folder. Restart the server
  55. and log on to your Odoo server. Select the Apps menu and upgrade the module by
  56. clicking on the upgrade button.
  57. If you installed the module using the "pip" command, you can also update the
  58. module in the same way. Just type the following command into the console:
  59. ``pip install --upgrade --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>``
  60. When the process is finished, restart your server and update the application in
  61. Odoo, just like you would normally.
  62. Configuration
  63. =============
  64. No additional configuration is needed to use this module.
  65. Usage
  66. =============
  67. This module has no direct visible effect on the system. It provide utility features.
  68. Credits
  69. =======
  70. Contributors
  71. ------------
  72. * Mathias Markl <mathias.markl@mukit.at>
  73. Images
  74. ------------
  75. Some pictures are based on or inspired by the icon set of Font Awesome:
  76. * `Font Awesome <https://fontawesome.com>`_
  77. Author & Maintainer
  78. -------------------
  79. This module is maintained by the `MuK IT GmbH <https://www.mukit.at/>`_.
  80. MuK IT is an Austrian company specialized in customizing and extending Odoo.
  81. We develop custom solutions for your individual needs to help you focus on
  82. your strength and expertise to grow your business.
  83. If you want to get in touch please contact us via mail
  84. (sale@mukit.at) or visit our website (https://mukit.at).