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.

71 lines
3.1 KiB

5 years ago
6 years ago
6 years ago
6 years ago
6 years ago
7 years ago
7 years ago
6 years ago
  1. [![License: AGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0)
  2. [![Build Status](https://travis-ci.org/muk-it/muk_base.svg?branch=12.0)](https://travis-ci.org/muk-it/muk_base)
  3. [![codecov](https://codecov.io/gh/muk-it/muk_base/branch/12.0/graph/badge.svg)](https://codecov.io/gh/muk-it/muk_base)
  4. [![Codacy Badge](https://api.codacy.com/project/badge/Grade/c867f25820614ed795e7567e37bd81c0)](https://www.codacy.com/app/keshrath/muk_base?utm_source=github.com&utm_medium=referral&utm_content=muk-it/muk_base&utm_campaign=Badge_Grade)
  5. [![Weblate](https://weblate.mukit.at/widgets/base-12/-/svg-badge.svg)](https://weblate.mukit.at/projects/base-12/)
  6. [![Demo](https://img.shields.io/badge/demo-Try%20me-243742.svg)](https://mukit.at/r/SgN)
  7. # MuK Odoo Base Modules
  8. This set of modules offers mainly utility functions and libraries that are intended to be used in other projects.
  9. ### Installation
  10. To install this module, you need to:
  11. Download the module and add it to your Odoo addons folder. Afterward,
  12. log on to your Odoo server and go to the Apps menu. Trigger the debug
  13. mode and update the list by clicking on the "Update Apps List" link. Now
  14. install the module by clicking on the install button.
  15. Another way to install this module is via the package management for
  16. Python ([PyPI]).
  17. To install our modules using the package manager make sure
  18. [odoo-autodiscover] is installed correctly. Then open a console and
  19. install the module by entering the following command:
  20. `pip install --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>`
  21. The module name consists of the Odoo version and the module name, where
  22. underscores are replaced by a dash.
  23. **Module:**
  24. `odoo<version>-addon-<module_name>`
  25. **Example:**
  26. `sudo -H pip3 install --extra-index-url https://nexus.mukit.at/repository/odoo/simple odoo11-addon-muk-utils`
  27. Once the installation has been successfully completed, the app is
  28. already in the correct folder. Log on to your Odoo server and go to the
  29. Apps menu. Trigger the debug mode and update the list by clicking on the
  30. "Update Apps List" link. Now install the module by clicking on the
  31. install button.
  32. You can also view available Apps directly in our [repository] and find a
  33. more detailed installation guide on our [website].
  34. ### Upgrade
  35. To upgrade this module, you need to:
  36. Download the module and add it to your Odoo addons folder. Restart the
  37. server and log on to your Odoo server. Select the Apps menu and upgrade
  38. the module by clicking on the upgrade button.
  39. If you installed the module using the "pip" command, you can also update
  40. the module in the same way. Just type the following command into the
  41. console:
  42. `pip install --upgrade --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>`
  43. When the process is finished, restart your server and update the
  44. application in Odoo, just like you would normally.
  45. [PyPI]: https://pypi.org/project/pip/
  46. [odoo-autodiscover]: https://pypi.org/project/odoo-autodiscover/
  47. [repository]: https://nexus.mukit.at/#browse/browse:odoo
  48. [website]: https://mukit.at/page/open-source
  49. [MuK IT]: https://www.mukit.at/