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

[17.0][MIG] Migrate web_widget_plotly_chart #2815

Merged
merged 23 commits into from
May 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
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
plotly==5.22.0
153 changes: 153 additions & 0 deletions web_widget_plotly_chart/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,153 @@
=================
Web Widget Plotly
=================

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

.. |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/17.0/web_widget_plotly_chart
:alt: OCA/web
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/web-17-0/web-17-0-web_widget_plotly_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=17.0
:alt: Try me on Runboat

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

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

.. image:: https://raw.githubusercontent.com/OCA/web/17.0/web_widget_plotly_chart/static/description/example.png
:alt: Plotly Chart inserted into an Odoo view

`Plotly <https://plot.ly/>`__ is a Python interactive visualization
library built on top of d3.js and stack.gl, plotly.js is a high-level,
declarative charting library. plotly.js ships with over 40 chart types,
including scientific charts, 3D graphs, statistical charts, SVG maps,
financial charts, and more.

If you want to see some samples of plotly's capabilities follow this
`link <https://github.com/plotly/plotly.py#overview>`__.

**Table of contents**

.. contents::
:local:

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

You need to install the python plotly library:

::

pip install plotly==5.22.0

Usage
=====

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

1. Import plotly:

import plotly

2. Declare a text computed field like this:

::

plotly_chart = fields.Text(
string='Plotly Chart',
compute='_compute_plotly_chart',
)

3. In its computed method do:

::

def _compute_plotly_chart(self):
for rec in self:
data = [{'x': [1, 2, 3], 'y': [2, 3, 4]}]
rec.plotly_chart = plotly.offline.plot(data,
include_plotlyjs=False,
output_type='div')

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

::

<div>
<field name="plotly_chart" widget="plotly_chart" nolabel="1"/>
</div>

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_plotly_chart%0Aversion:%2017.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
-------

* LevelPrime srl

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

- Roberto Fichera <roberto.fichera@levelprime.com>
- Michele Zaccheddu <michele.zaccheddu@levelprime.com>

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

- This module uses the library
`Plotly.js <https://github.com/plotly/plotly.js>`__ which is under
the open-source MIT License. Copyright (c) 2019 Plotly, 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-robyf70| image:: https://github.com/robyf70.png?size=40px
:target: https://github.com/robyf70
:alt: robyf70

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

|maintainer-robyf70|

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

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
Empty file.
21 changes: 21 additions & 0 deletions web_widget_plotly_chart/__manifest__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"name": "Web Widget Plotly",
"summary": """Allow to draw plotly charts.""",
"author": "LevelPrime srl, Odoo Community Association (OCA)",
"maintainers": ["robyf70"],
"website": "https://github.com/OCA/web",
"category": "Web",
"version": "17.0.1.0.0",
"depends": ["web"],
"data": [],
"external_dependencies": {
"python": ["plotly==5.22.0"],
},
"assets": {
"web.assets_backend": [
"web_widget_plotly_chart/static/src/js/widget_plotly.esm.js",
"web_widget_plotly_chart/static/src/js/widget_plotly.xml",
],
},
"license": "LGPL-3",
}
Empty file.
Empty file.
Empty file.
14 changes: 14 additions & 0 deletions web_widget_plotly_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"
Empty file.
13 changes: 13 additions & 0 deletions web_widget_plotly_chart/i18n/web_widget_plotly_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 16.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"
3 changes: 3 additions & 0 deletions web_widget_plotly_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"
2 changes: 2 additions & 0 deletions web_widget_plotly_chart/readme/CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- Roberto Fichera \<<roberto.fichera@levelprime.com>\>
- Michele Zaccheddu \<<michele.zaccheddu@levelprime.com>\>
4 changes: 4 additions & 0 deletions web_widget_plotly_chart/readme/CREDITS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
- This module uses the library
[Plotly.js](https://github.com/plotly/plotly.js) which is under the
open-source MIT License. Copyright (c) 2019 Plotly, Inc
- Odoo Community Association (OCA)
13 changes: 13 additions & 0 deletions web_widget_plotly_chart/readme/DESCRIPTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
This module add the possibility to insert Plotly charts into Odoo
standard views.

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

[Plotly](https://plot.ly/) is a Python interactive visualization library
built on top of d3.js and stack.gl, plotly.js is a high-level,
declarative charting library. plotly.js ships with over 40 chart types,
including scientific charts, 3D graphs, statistical charts, SVG maps,
financial charts, and more.

If you want to see some samples of plotly's capabilities follow this
[link](https://github.com/plotly/plotly.py#overview).
3 changes: 3 additions & 0 deletions web_widget_plotly_chart/readme/INSTALL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
You need to install the python plotly library:

pip install plotly==5.22.0
28 changes: 28 additions & 0 deletions web_widget_plotly_chart/readme/USAGE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
To insert a Plotly chart in a view proceed as follows:

1. Import plotly:

import plotly

2. Declare a text computed field like this:

plotly_chart = fields.Text(
string='Plotly Chart',
compute='_compute_plotly_chart',
)

3. In its computed method do:

def _compute_plotly_chart(self):
for rec in self:
data = [{'x': [1, 2, 3], 'y': [2, 3, 4]}]
rec.plotly_chart = plotly.offline.plot(data,
include_plotlyjs=False,
output_type='div')

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

<div>
<field name="plotly_chart" widget="plotly_chart" nolabel="1"/>
</div>
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