Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[18.0][MIG] web_widget_bokeh_chart #3076

Open
wants to merge 58 commits into
base: 18.0
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
58 commits
Select commit Hold shift + click to select a range
777cf08
[9.0][ADD] web_widget_bokeh_chart
LoisRForgeFlow Sep 6, 2017
4d24900
[10.0][MIG] web_widget_bokeh_chart
LoisRForgeFlow Dec 27, 2017
932489d
[FIX] web_widget_bokeh: Fix README syntax
pedrobaeza Feb 7, 2018
961b20e
[MIG] web_widget_bokeh_chart: Migration to 11.0
Feb 16, 2018
a9c7d0c
[UPD] Update web_widget_bokeh_chart.pot
oca-travis Jun 24, 2018
7fc86cb
[FIX] Display bug web_widget_bokeh_chart
AdriaGForgeFlow Feb 14, 2019
d3a259b
[11.0][FIX] web_widget_bokeh_chart: fix grahs expanding outside the c…
LoisRForgeFlow Mar 8, 2019
f7c7f09
[MIG] web_widget_bokeh_chart: Migration to 12.0
MiquelRForgeFlow Mar 20, 2019
c64b5a2
[MIG] bokeh library to version 1.1.0
AdriaGForgeFlow May 24, 2019
e59dbed
[UPD] README.rst
OCA-git-bot Jul 31, 2019
2badb73
[UPD] Update web_widget_bokeh_chart.pot
oca-travis Jul 31, 2019
2d3a4c1
Added translation using Weblate (Chinese (Simplified))
liweijie0812 Sep 1, 2019
4501aa5
[12.0][IMP][web_widget_bokeh_chart] Render readonly the widget to per…
robyf70 Sep 9, 2019
b67c6b7
web_widget_bokeh_chart 12.0.1.0.1
OCA-git-bot Sep 23, 2019
0fe4f74
[12.0] web_widget_bokeh_chart: update documentation and set a maintai…
LoisRForgeFlow Sep 27, 2019
f2d4f1f
[13.0][MIG] web_widget_bokeh_chart
AdriaGForgeFlow Dec 17, 2019
23824c3
[UPD] Update web_widget_bokeh_chart.pot
oca-travis Dec 23, 2019
543ddf5
[UPD] README.rst
OCA-git-bot Dec 23, 2019
5afb1a5
[IMP] pre-commit run after update
Jan 24, 2020
af371a5
pre-commit update: prettier xml indent
sbidoul Mar 2, 2020
1a08055
[UPD] README.rst
OCA-git-bot Jul 13, 2020
d264d8d
[UPD] README.rst
OCA-git-bot Jul 13, 2020
cefcd79
[UPD] Eficent -> ForgeFlow
MiquelRForgeFlow Sep 30, 2020
465890f
[UPD] README.rst
OCA-git-bot Oct 16, 2020
1517975
[IMP] web_widget_bokeh_chart: black, isort, prettier
DavidBForgeFlow Feb 4, 2021
5189086
[MIG] web_widget_bokeh_chart: Migration to 14.0
DavidBForgeFlow Feb 4, 2021
a6c5d8e
[UPD] Update web_widget_bokeh_chart.pot
oca-travis Mar 31, 2021
badda9c
[UPD] README.rst
OCA-git-bot Mar 31, 2021
6f1d9bc
[FIX] requirement for bokeh should specify the version
LoisRForgeFlow Mar 31, 2021
e92cee4
[IMP] web_widget_bokeh_chart: Upgrade library version
etobella Apr 28, 2021
7761eb6
[FIX] web_widget_bokeh_chart: Correct bokeh library versio in install…
DavidBForgeFlow Apr 30, 2021
c84b332
[UPD] README.rst
OCA-git-bot Apr 30, 2021
9019e6d
[15.0][MIG] web_widget_bokeh_chart
ChrisOForgeFlow Dec 10, 2021
29ac421
[UPD] Update web_widget_bokeh_chart.pot
Jan 12, 2022
255326c
[UPD] README.rst
OCA-git-bot Jan 12, 2022
0ac8f69
[FIX] web_widget_bokeh_chart: Activate script and div at the same time
BernatPForgeFlow Mar 9, 2022
0a751de
[DOC] web_widget_bokeh_chart
gurneyalex Apr 6, 2022
45cb676
web_widget_bokeh_chart 15.0.1.1.0
OCA-git-bot Apr 13, 2022
a4529d2
[UPD] README.rst
OCA-git-bot Apr 26, 2022
379b9f3
web_widget_bokeh_chart 15.0.1.1.1
OCA-git-bot Apr 26, 2022
8474260
[MIG] web_widget_bokeh_chart: Migration to 16.0
OriolMForgeFlow Jun 6, 2023
15c6f1a
[UPD] Update web_widget_bokeh_chart.pot
Jun 14, 2023
c0fb3c7
[UPD] README.rst
OCA-git-bot Jun 14, 2023
13bbc08
web_widget_bokeh_chart 16.0.1.0.1
OCA-git-bot Jun 14, 2023
df5c9fd
Update translation files
weblate Jun 14, 2023
f4a63f3
[FIX] web_widget_bokeh_chart : bad image path breaks readme generation
legalsylvain Jul 26, 2023
00a87cc
[UPD] README.rst
OCA-git-bot Jul 27, 2023
1c3c8c5
web_widget_bokeh_chart 16.0.1.0.2
OCA-git-bot Jul 27, 2023
3ff2a8c
[UPD] README.rst
OCA-git-bot Sep 3, 2023
813f3eb
[FIX] web_widget_bokeh_chart: Make bokeh charts work when inputs change
BernatPForgeFlow Jul 12, 2023
7683457
[BOT] post-merge updates
OCA-git-bot Nov 15, 2023
70b5a04
Added translation using Weblate (Italian)
mymage Nov 27, 2023
660671f
[IMP] web_widget_bokeh_chart: pre-commit stuff
DavidJForgeFlow Jun 13, 2024
c276310
[MIG] web_widget_bokeh_chart: Migration to 17.0
DavidJForgeFlow Jun 13, 2024
7b9cbdc
[UPD] Update web_widget_bokeh_chart.pot
Jun 14, 2024
d7e6cee
[BOT] post-merge updates
OCA-git-bot Jun 14, 2024
b5a6c4f
[IMP] web_widget_bokeh_chart: black, isort, prettier
JasminSForgeFlow Dec 19, 2024
b7aea1d
[MIG] web_widget_bokeh_chart: Migration to 18.0
JasminSForgeFlow Feb 3, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# generated from manifests external_dependencies
bokeh==3.4.1
223 changes: 223 additions & 0 deletions web_widget_bokeh_chart/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,223 @@
======================
Web Widget Bokeh Chart
======================

..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:10c41bedda1b6bac903e84df063e14319600ee78c9765ecb085b9acdf6fe97c6
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Production%2FStable-green.png
:target: https://odoo-community.org/page/development-status
:alt: Production/Stable
.. |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/18.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-18-0/web-18-0-web_widget_bokeh_chart
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
:target: https://runboat.odoo-community.org/builds?repo=OCA/web&target_branch=18.0
:alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

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

|Bokeh Chart inserted into an Odoo view|

`Bokeh <https://bokeh.pydata.org>`__ 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 <https://bokeh.pydata.org/en/latest/docs/gallery.html>`__.

.. |Bokeh Chart inserted into an Odoo view| image:: https://raw.githubusercontent.com/OCA/web/18.0/web_widget_bokeh_chart/static/description/example.png

**Table of contents**

.. contents::
:local:

Installation
============

You need to install the python bokeh library:

::

pip3 install bokeh==3.1.1

Usage
=====

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

Using a Char field
------------------

1. Declare a text computed field like this:

::

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

2. At the top of the module add the following imports:

::

from bokeh.plotting import figure
from bokeh.embed import components
import json

3. In its computed method do:

::

def _compute_bokeh_chart(self):
for rec in self:
# Design your bokeh figure:
p = 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, wrap_script=False)
rec.bokeh_chart = json.dumps({"div": div, "script": script})

4. 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>

Using a Json field
------------------

1. Declare a json computed field like this:

::

bokeh_chart = fields.Json(
string='Bokeh Chart',
compute='_compute_bokeh_chart',
)

2. At the top of the module add the following imports:

::

from bokeh.plotting import figure
from bokeh.embed import components

3. In its computed method do:

::

def _compute_bokeh_chart(self):
for rec in self:
# Design your bokeh figure:
p = 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, wrap_script=False)
rec.bokeh_chart = {"div": div, "script": script}

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

::

<div>
<field name="bokeh_chart" widget="bokeh_chart_json

Known issues / Roadmap
======================

1. On 17, we could remove the char field and only use the Json Field

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/web/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/web/issues/new?body=module:%20web_widget_bokeh_chart%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

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

Credits
=======

Authors
-------

* ForgeFlow
* Creu Blanca

Contributors
------------

- Jordi Ballester Alomar <[email protected]>
- Lois Rilo Antelo <[email protected]>
- Artem Kostyuk <[email protected]>
- Christopher Ormaza <[email protected]>
- Enric Tobella <[email protected]>
- Oriol Miranda Garrido <[email protected]>
- Bernat Puig Font <[email protected]>

Other credits
-------------

- This module uses the library
`Bokeh <https://github.com/bokeh/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.

.. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association
:target: https://odoo-community.org

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.

.. |maintainer-LoisRForgeFlow| image:: https://github.com/LoisRForgeFlow.png?size=40px
:target: https://github.com/LoisRForgeFlow
:alt: LoisRForgeFlow
.. |maintainer-ChrisOForgeFlow| image:: https://github.com/ChrisOForgeFlow.png?size=40px
:target: https://github.com/ChrisOForgeFlow
:alt: ChrisOForgeFlow

Current `maintainers <https://odoo-community.org/page/maintainer-role>`__:

|maintainer-LoisRForgeFlow| |maintainer-ChrisOForgeFlow|

This module is part of the `OCA/web <https://github.com/OCA/web/tree/18.0/web_widget_bokeh_chart>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
1 change: 1 addition & 0 deletions web_widget_bokeh_chart/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
25 changes: 25 additions & 0 deletions web_widget_bokeh_chart/__manifest__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Copyright 2017 ForgeFlow S.L.
# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).

{
"name": "Web Widget Bokeh Chart",
"category": "Hidden",
"summary": "This widget allows to display charts using Bokeh library.",
"author": "ForgeFlow, " "Odoo Community Association (OCA), " "Creu Blanca",
"version": "18.0.1.0.0",
"maintainers": ["LoisRForgeFlow", "ChrisOForgeFlow"],
"development_status": "Production/Stable",
"website": "https://github.com/OCA/web",
"depends": ["web"],
"data": [],
"external_dependencies": {"python": ["bokeh==3.4.1"]},
"auto_install": False,
"license": "LGPL-3",
"assets": {
"web.assets_backend": [
"web_widget_bokeh_chart/static/src/js/web_widget_bokeh_chart.esm.js",
"web_widget_bokeh_chart/static/src/js/web_widget_bokeh_json_chart.esm.js",
"web_widget_bokeh_chart/static/src/xml/bokeh.xml",
],
},
}
14 changes: 14 additions & 0 deletions web_widget_bokeh_chart/i18n/it.po
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
#
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 16.0\n"
"Report-Msgid-Bugs-To: \n"
"Last-Translator: Automatically generated\n"
"Language-Team: none\n"
"Language: it\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: \n"
"Plural-Forms: nplurals=2; plural=n != 1;\n"
13 changes: 13 additions & 0 deletions web_widget_bokeh_chart/i18n/web_widget_bokeh_chart.pot
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
#
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 17.0\n"
"Report-Msgid-Bugs-To: \n"
"Last-Translator: \n"
"Language-Team: \n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: \n"
"Plural-Forms: \n"
Empty file.
3 changes: 3 additions & 0 deletions web_widget_bokeh_chart/pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[build-system]
requires = ["whool"]
build-backend = "whool.buildapi"
7 changes: 7 additions & 0 deletions web_widget_bokeh_chart/readme/CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
- Jordi Ballester Alomar \<<[email protected]>\>
- Lois Rilo Antelo \<<[email protected]>\>
- Artem Kostyuk \<<[email protected]>\>
- Christopher Ormaza \<<[email protected]>\>
- Enric Tobella \<<[email protected]>\>
- Oriol Miranda Garrido \<<[email protected]>\>
- Bernat Puig Font \<<[email protected]>\>
4 changes: 4 additions & 0 deletions web_widget_bokeh_chart/readme/CREDITS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
- This module uses the library [Bokeh](https://github.com/bokeh/bokeh)
which is under the open-source BSD 3-clause "New" or "Revised"
License. Copyright (c) 2012, Anaconda, Inc.
- Odoo Community Association (OCA)
15 changes: 15 additions & 0 deletions web_widget_bokeh_chart/readme/DESCRIPTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
This module add the possibility to insert Bokeh charts into Odoo
standard views.

![Bokeh Chart inserted into an Odoo view](../static/description/example.png)

[Bokeh](https://bokeh.pydata.org) 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](https://bokeh.pydata.org/en/latest/docs/gallery.html).
3 changes: 3 additions & 0 deletions web_widget_bokeh_chart/readme/INSTALL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
You need to install the python bokeh library:

pip3 install bokeh==3.1.1
1 change: 1 addition & 0 deletions web_widget_bokeh_chart/readme/ROADMAP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
1. On 17, we could remove the char field and only use the Json Field
67 changes: 67 additions & 0 deletions web_widget_bokeh_chart/readme/USAGE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
To insert a Bokeh chart in a view proceed as follows:

## Using a Char field

1. Declare a text computed field like this:

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

2. At the top of the module add the following imports:

from bokeh.plotting import figure
from bokeh.embed import components
import json

3. In its computed method do:

def _compute_bokeh_chart(self):
for rec in self:
# Design your bokeh figure:
p = 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, wrap_script=False)
rec.bokeh_chart = json.dumps({"div": div, "script": script})

4. 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>

## Using a Json field

1. Declare a json computed field like this:

bokeh_chart = fields.Json(
string='Bokeh Chart',
compute='_compute_bokeh_chart',
)

2. At the top of the module add the following imports:

from bokeh.plotting import figure
from bokeh.embed import components

3. In its computed method do:

def _compute_bokeh_chart(self):
for rec in self:
# Design your bokeh figure:
p = 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, wrap_script=False)
rec.bokeh_chart = {"div": div, "script": script}

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

<div>
<field name="bokeh_chart" widget="bokeh_chart_json
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading