muk_base/muk_fields_stream/README.rst

=========================

MuK Binary Stream Support

=========================



This module adds a new http route which allows to download binary data as a stream. 

This is especially useful for large files, because they don't fit in the ram as a

whole and can easily cause an error because ram limits are exceeded. This module 

serves as a basis for a number of extensions that add fields to Odoo which support 

this functionality.



Installation

============



To install this module, you need to:



Download the module and add it to your Odoo addons folder. Afterward, log on to

your Odoo server and go to the Apps menu. Trigger the debug mode and update the

list by clicking on the "Update Apps List" link. Now install the module by

clicking on the install button.



Another way to install this module is via the package management for Python

(`PyPI <https://pypi.org/project/pip/>`_).



To install our modules using the package manager make sure

`odoo-autodiscover <https://pypi.org/project/odoo-autodiscover/>`_ is installed

correctly. Note that for Odoo version 11.0 and later this is not necessary anymore. 

Then open a console and install the module by entering the following command:



``pip install --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>``



The module name consists of the Odoo version and the module name, where

underscores are replaced by a dash.



**Module:**



``odoo<version>-addon-<module_name>``



**Example:**



``sudo -H pip3 install --extra-index-url https://nexus.mukit.at/repository/odoo/simple odoo13-addon-muk-utils``



Once the installation has been successfully completed, the app is already in the

correct folder. Log on to your Odoo server and go to the Apps menu. Trigger the

debug mode and update the list by clicking on the "Update Apps List" link. Now

install the module by clicking on the install button.



The biggest advantage of this variant is that you can now also update the app

using the "pip" command. To do this, enter the following command in your console:



``pip install --upgrade --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>``



When the process is finished, restart your server and update the application in

Odoo. The steps are the same as for the installation only the button has changed

from "Install" to "Upgrade".



You can also view available Apps directly in our `repository <https://nexus.mukit.at/#browse/browse:odoo>`_

and find a more detailed installation guide on our `website <https://mukit.at/page/open-source>`_.



For modules licensed under a proprietary license, you will receive the access data after you purchased

the module. If the purchase were made at the Odoo store please contact our `support <support@mukit.at>`_

with a confirmation of the purchase to receive the corresponding access data.



Upgrade

============



To upgrade this module, you need to:



Download the module and add it to your Odoo addons folder. Restart the server

and log on to your Odoo server. Select the Apps menu and upgrade the module by

clicking on the upgrade button.



If you installed the module using the "pip" command, you can also update the

module in the same way. Just type the following command into the console:



``pip install --upgrade --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>``



When the process is finished, restart your server and update the application in

Odoo, just like you would normally.





Configuration

=============



No additional configuration is needed to use this module.



Usage

=====



This module has no direct visible effect on the system. It adds a new route

which can be used by modules which add fields with stream capability.



Credit

======



Contributors

------------



* Mathias Markl <mathias.markl@mukit.at>



Images

------



Some pictures are based on or inspired by the icon set of Font Awesome:



* `Font Awesome <https://fontawesome.com>`_



Author & Maintainer

-------------------



This module is maintained by the `MuK IT GmbH <https://www.mukit.at/>`_.



MuK IT is an Austrian company specialized in customizing and extending Odoo.

We develop custom solutions for your individual needs to help you focus on

your strength and expertise to grow your business.



If you want to get in touch please contact us via `mail <sale@mukit.at>`_

or visit our `website  <https://mukit.at>`_.