diff --git a/web_widget_bokeh_chart/README.rst b/web_widget_bokeh_chart/README.rst index 659f58991..e8f9c3e3b 100644 --- a/web_widget_bokeh_chart/README.rst +++ b/web_widget_bokeh_chart/README.rst @@ -1,14 +1,33 @@ -.. image:: https://img.shields.io/badge/license-LGPL--3-blue.png - :target: https://www.gnu.org/licenses/lgpl - :alt: License: LGPL-3 - ====================== Web Widget Bokeh Chart ====================== +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png + :target: https://odoo-community.org/page/development-status + :alt: Beta +.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png + :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html + :alt: License: LGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github + :target: https://github.com/OCA/web/tree/12.0/web_widget_bokeh_chart + :alt: OCA/web +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/web-12-0/web-12-0-web_widget_bokeh_chart + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/162/12.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + This module add the possibility to insert Bokeh charts into Odoo standard views. -.. image:: /web_widget_bokeh_chart/static/description/example.png +.. image:: https://raw.githubusercontent.com/web_widget_bokeh_chart/static/description/example.png :alt: Bokeh Chart inserted into an Odoo view :width: 600 px @@ -23,12 +42,17 @@ plots, dashboards, and data applications. If you want to see some samples of bokeh's capabilities follow this `link `_. +**Table of contents** + +.. contents:: + :local: + Installation ============ You need to install the python bokeh library:: - pip3 install bokeh==1.1.0 + pip3 install bokeh==0.12.7 Usage ===== @@ -64,37 +88,49 @@ To insert a Bokeh chart in a view proceed as follows: Bug Tracker =========== -Bugs are tracked on `GitHub Issues -`_. In case of trouble, please -check there if your issue has already been reported. If you spotted it first, -help us smash it by providing detailed and welcomed feedback. +Bugs are tracked on `GitHub 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 `_. + +Do not contact contributors directly about support or help with technical issues. Credits ======= +Authors +~~~~~~~ + +* Eficent + +Contributors +~~~~~~~~~~~~ + +* Jordi Ballester Alomar +* Lois Rilo Antelo +* Artem Kostyuk + +Other credits +~~~~~~~~~~~~~ + * This module uses the library `Bokeh `__ which is under the open-source BSD 3-clause "New" or "Revised" License. Copyright (c) 2012, Anaconda, Inc. * Odoo Community Association (OCA) -Contributors ------------- +Maintainers +~~~~~~~~~~~ -* Jordi Ballester Alomar -* Lois Rilo Antelo -* Artem Kostyuk - -Maintainer ----------- +This module is maintained by the OCA. .. image:: https://odoo-community.org/logo.png :alt: Odoo Community Association :target: https://odoo-community.org -This module is maintained by the OCA. - 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. -To contribute to this module, please visit https://odoo-community.org. +This module is part of the `OCA/web `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/web_widget_bokeh_chart/static/description/index.html b/web_widget_bokeh_chart/static/description/index.html new file mode 100644 index 000000000..9afac72fb --- /dev/null +++ b/web_widget_bokeh_chart/static/description/index.html @@ -0,0 +1,484 @@ + + + + + + +Web Widget Bokeh Chart + + + +
+

Web Widget Bokeh Chart

+ + +

Beta License: LGPL-3 OCA/web Translate me on Weblate Try me on Runbot

+

This module add the possibility to insert Bokeh charts into Odoo standard views.

+Bokeh Chart inserted into an Odoo view +

Bokeh is a Python interactive visualization +library that targets modern web browsers for presentation. Its goal is to +provide elegant, concise construction of basic exploratory and advanced +custom graphics in the style of D3.js, but also deliver this capability with +high-performance interactivity over very large or streaming datasets. Bokeh +can help anyone who would like to quickly and easily create interactive +plots, dashboards, and data applications.

+

If you want to see some samples of bokeh’s capabilities follow this link.

+

Table of contents

+ +
+

Installation

+

You need to install the python bokeh library:

+
+pip3 install bokeh==0.12.7
+
+
+
+

Usage

+

To insert a Bokeh chart in a view proceed as follows:

+
    +

  1. Declare a text computed field like this:

    +
    +bokeh_chart = fields.Text(
+    string='Bokeh Chart',
+    compute='_compute_bokeh_chart',
+)
+
    +
    2. +

  2. In its computed method do:

    +
    +def _compute_bokeh_chart(self):
+    for rec in self:
+        # Design your bokeh figure:
+        p = figure()  # import that as `from bokeh.plotting import figure`
+        line = p.line([0, 2], [1, 8], line_width=5)
+        # (...)
+        # fill the record field with both markup and the script of a chart.
+        script, div = components(p)
+        rec.bokeh_chart = '%s%s' % (div, script)
+
    +
    3. +

  3. In the view, add something like this wherever you want to display your +bokeh chart:

    +
    +<div>
+    <field name="bokeh_chart" widget="bokeh_chart" nolabel="1"/>
+</div>
+
    +
    4. +
+
+
+

Bug Tracker

+

Bugs are tracked on GitHub 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.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • Eficent
    • +
+
+
+

Contributors

+ +
+
+

Other credits

+
    +
  • This module uses the library Bokeh +which is under the open-source BSD 3-clause “New” or “Revised” License. +Copyright (c) 2012, Anaconda, Inc.
    • +
  • Odoo Community Association (OCA)
    • +
+
+
+

Maintainers

+

This module is maintained by the OCA.

+Odoo Community Association +

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/web project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ +