How to integrate with other applications like flask, frappe or django?

[KathirvelPriya]

Question

How to integrate with other applications like flask, frappe or django?

Code/Examples

No response

Other information

No response

Which package?

None

Package version

No response

Python version

No response

OS

No response

Code of Conduct

• I agree to follow the Code of Conduct.

[antonymilne]

Hi @KathirvelPriya, thanks for your question. Under the hood, Vizro wraps Dash, which itself wraps a Flask app. Hence your question is basically the same as asking how to integrate a Dash app into a web framework.

• any arguments that you pass into Dash should be passed exactly the same into Vizro, e.g. Dash(routes_pathname_prefix="/dashboard/") becomes Vizro(routes_pathname_prefix="/dashboard/")
• the only difference is that the Flask server in Dash is exposed via app.server; in Vizro it's one level deeper in app.dash.server

If you search for how to integrate a Dash app into a web framework then you'll find lots of discussion of it e.g. on the plotly forums. Here's some pointers though:

• if you haven't already chosen a web framework then Flask will be the easiest choice for integration with Dash/Vizro, because Dash/Vizro uses Flask already. There's various different methods here, e.g. https://hackersandslackers.com/plotly-dash-with-flask/, https://github.com/okomarov/dash_on_flask, https://community.plotly.com/t/how-to-add-your-dash-app-to-flask/51870/2.
• Django is possible but more complicated - see e.g. https://community.plotly.com/t/django-dash-new-improved-relationship-authentication/71273, https://dash.plotly.com/dash-enterprise/application-structure/django-app?de-version=5.2, https://github.com/GibbsConsulting/django-plotly-dash
• Frappe seems to be a less popular choice for integration with Dash but see e.g. https://github.com/pipech/frappe-plotly-dash

Here's a very simple working example of Vizro inside an existing Flask app (which, as discussed in this article, might not be the way you actually want to do it, but serves as a good proof of concept).

import flask
import vizro
import vizro.models as vm

server = flask.Flask(__name__)

@server.route("/")
def home():
    return "Hello, Flask!"

page = vm.Page(title="My first page", components=[vm.Card(text="Hello, Vizro!")])
dashboard = vm.Dashboard(pages=[page])

app = vizro.Vizro(server=server, routes_pathname_prefix="/dashboard/").build(dashboard)
app.run()

http://127.0.0.1:8050/ gives the Flask app:

http://127.0.0.1:8050/dashboard/ gives the Vizro app:

[KathirvelPriya]

Hi @antonymilne,
Thanks for your reply. I want to integrate with Frappe. I referred plotly-frappe-dash before. But it couldn't help in latest version of frappe.

[antonymilne]

Ah, that's a pity. I recommend posting on the plotly forums to see if they can help you with that. Basically if you can get it working with pure Dash then you should easily be able to get it working with Vizro. And if you can't get it working with pure Dash then unfortunately you won't be able to get it working with Vizro.

[KathirvelPriya]

Thank you for your response. I will try.