Skip to main content

Datapane client library and CLI tool

Project description

Datapane

Datapane Cloud | Documentation | API Docs | Twitter | Blog

Pip Downloads Latest release Conda (channel only)

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.

Report Example

Getting Started

Install

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

Next Steps

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!

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

datapane-0.11.3.tar.gz (1.2 MB view details)

Uploaded Source

Built Distribution

datapane-0.11.3-py3-none-any.whl (1.2 MB view details)

Uploaded Python 3

File details

Details for the file datapane-0.11.3.tar.gz.

File metadata

  • Download URL: datapane-0.11.3.tar.gz
  • Upload date:
  • Size: 1.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.6 CPython/3.9.5 Linux/5.4.0-1047-azure

File hashes

Hashes for datapane-0.11.3.tar.gz
Algorithm Hash digest
SHA256 5b3d2d1f26aa173d5813278cb77db1150c8eb8e63676b9aac1bb21f1ddcbfb61
MD5 3b883aecaf2960b7bd37e837a8fd5847
BLAKE2b-256 540b2599ea8bfee96a012a62ef51e4e2a9ae9db73febc6d03149d14683106fa5

See more details on using hashes here.

File details

Details for the file datapane-0.11.3-py3-none-any.whl.

File metadata

  • Download URL: datapane-0.11.3-py3-none-any.whl
  • Upload date:
  • Size: 1.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.6 CPython/3.9.5 Linux/5.4.0-1047-azure

File hashes

Hashes for datapane-0.11.3-py3-none-any.whl
Algorithm Hash digest
SHA256 7550f6ac528acfda4d8d5ce7bb54d5ed0cbf7a012b03eb6257974752c223ef90
MD5 ccb0f68864dae941f04f366a60b597b1
BLAKE2b-256 c73df8ddd6450507be1e0bfb5b1c4d67b944ccbb74dc5c35038003c7573e9690

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page