datapane 0.11.1

Datapane client library and CLI tool

Datapane Cloud | Documentation | API Docs | Twitter | Blog

Datapane is a Python library which makes it simple to build documents from the common objects in your data analysis, such as pandas DataFrames, plots from Python visualisation libraries, and Markdown.

Reports can be exported as standalone HTML documents, with rich components which allow data to be explored and visualisations to be used interactively.

For example, if you wanted to create a document with a table viewer and an interactive plot:

import pandas as pd
import altair as alt
import datapane as dp

df = pd.read_csv('https://covid.ourworldindata.org/data/vaccinations/vaccinations-by-manufacturer.csv', parse_dates=['date'])
df = df.groupby(['vaccine', 'date'])['total_vaccinations'].sum().reset_index()

plot = alt.Chart(df).mark_area(opacity=0.4, stroke='black').encode(
    x='date:T',
    y=alt.Y('total_vaccinations:Q'),
    color=alt.Color('vaccine:N', scale=alt.Scale(scheme='set1')),
    tooltip='vaccine:N'
).interactive().properties(width='container')

total_df = df[df["date"] == df["date"].max()].sort_values("total_vaccinations", ascending=False).reset_index(drop=True)
total_styled = total_df.style.bar(subset=["total_vaccinations"], color='#5fba7d', vmax=total_df["total_vaccinations"].sum())

dp.Report("## Vaccination Report",
    dp.Plot(plot, caption="Vaccinations by manufacturer over time"),
    dp.Table(total_styled, caption="Current vaccination totals by manufacturer")
).save(path='report.html', open=True)

This would package a standalone HTML report document such as the following, with a searchable DataTable and Plot component.

Getting Started

Install

• pip3 install datapane OR
• conda install -c conda-forge "datapane>=0.10.0"

Next Steps

• Read the documentation
• Browse the API docs
• Browse samples and demos
• View featured documents

Datapane Community

In addition to saving documents locally, Datapane Community is a free hosted platform and social network, including the following features:

• published documents can kept private and securely shared,
• documents can be shared publicly and become a part of the wider data stories community,
• document embedding within your blogs, CMSs, and elsewhere (see here),
• explorations and integrations, e.g. additional DataTable analysis features and GitHub actions integration.

It's super simple, just login (see here) and call the publish function on your report,

r = dp.Report(dp.DataTable(df), dp.Plot(chart))
r.publish(name="2020 Stock Portfolio", open=True)

Datapane Cloud

Datapane Cloud provides automation and secure sharing of documents within in your organization.

• Private document sharing within your organization and within groups, including external clients
• Convert notebooks and scripts into apps, with inputs that can be run by your team interactively
• Schedule documents to be generated and shared
• Runs managed or on-prem
• and more

Joining the community

Looking to get answers to questions or engage with us and the wider community? Check out our GitHub Discussions board.

Submit feature requests, issues, and bug reports on this GitHub repo.

We look forward to building an amazing open source community with you!

Open-source, not open-contribution

We apologise for having to do this, but Datapane is closed to code contributions (at this time).

The Datapane team is too small to be accepting and maintaining third party patches for now. Small contributions typically require hours of time to properly test and validate.

However, we are tremendously grateful to the community for any feature requests, ideas, discussions, bug reports, and general involvement!