Reports

Reports present results of analyses, such as datasets and plots, as web pages which you can share and embed.
An example report on Datapane

Reports can be comprised of the following components. To learn more about each component, refer to the respective documentation.

Component

Description

Table

Tabular data from a pandas DataFrames, which users can filter and sort

Plot

Plots from Python visualisation libraries, such as Bokeh and Altair

Markdown

Markdown, in order to document your report

Create a Report

Overview

Using Datapane's Python library, use the static create method on the Report object to create your report.

Example

import datapane as dp
report = dp.Report.create([..components..])
print(r.url)

The url of your report will be available on the .url object.

Reports can be created ad-hoc for individual analyses, or generated dynamically through Scripts

Embedding

Overview

Reports can be embedded onto other platforms, such as your internal wiki, a web page, or social medium platforms such as Reddit and Medium.

Embedding a Datapane Report

If your report is public, you can retrieve the public, embeddable URL of a report on embed_url. For reports that are either private, or are only available to those inside the organisation, you can get a signed embed link on private_embed_url. This link contains a key which allows anyone with the link to view the report. You can also access both the embed and private embed URLs of reports through the web interface. If a report is private or only available to the domain, the embed link will automatically contain an access token.

Embed bar in the web UI