Skip to content

Quickstart

These quick instructions will get you up and running with Datapane in a few minutes! Check the in-depth tutorials to learn more. You could also check out our Datapane in 3 minutes video below!

Installation

Datapane's Python library and CLI can be installed using either conda or pip on macOS, Windows, or Linux. Datapane supports Python 3.6 - 3.9.

Installing Python

Instructions for installing Python can be found at https://wiki.python.org/moin/BeginnersGuide/Download.

Datapane can be installed with:

conda install -c conda-forge "datapane>=0.14.0"
pip3 install datapane

Creating a report

Let’s create a simple report. In this scenario, we have a dataset and visualization that we need to share with our colleagues.

import altair as alt
from vega_datasets import data

df = data.iris()
fig = (
    alt.Chart(df)
    .mark_point()
    .encode(x="petalLength:Q", y="petalWidth:Q", color="species:N")
)

Datapane makes generating a report simple – all it takes is the following.

import datapane as dp

report = dp.Report(
    dp.Plot(fig),
    dp.DataTable(df)
)

report.save(path="quickstarter.html")

This will generate an HTML file, quickstarter.html, containing our interactive report:

We can now open our standalone HTML report with a web browser and email it to our colleagues who can do the same.

But what if we want to send a link to our report or embed it instead?

Uploading to Datapane Cloud

Datapane Cloud is free! Share reports privately, or embed them into platforms like Salesforce and Medium.

To get a free API key, sign up for an account at https://datapane.com/accounts/signup/ and login using the following

datapane login

Once we've logged in, the API key will be stored in the current environment.

report.upload(name="Quickstart")

By using upload() in place of save(), our report is uploaded to Datapane Cloud and a shareable link is generated.

We can now send this link to our colleagues or use it to embed our report on another platform.