Reports
Examples & Tutorials
Uploading and Sharing
Uploading your report so you can share it with others
This feature requires use of the free Datapane Studio hosted platform or a private Datapane Teams instance
Upload your report
So far we've demonstrated how to build and view reports locally; however, one of the most powerful features of Datapane is the ability to upload your report straight from your code and share it directly with your team or the wider world.
Once you've logged in to your chosen Datapane server, call
report.upload(name='Your report name') in your script and your report will be uploaded to your Datapane instance for viewing online. This will return the URL of the report that you can share.Report.upload was previously called Report.publish. The old syntax will still work but has been deprecated. Let's see an example report uploaded to Datapane.com, with the
uploadsyntax. Set the open boolean parameter to True to open the report afterwards automatically, and add a description to change the preview text for your viewers. richer_report.py
1
import altair as alt
2
from vega_datasets import data
3
import datapane as dp
4
5
source = data.cars()
6
7
plot1 = alt.Chart(source).mark_circle(size=60).encode(
8
x='Horsepower',
9
y='Miles_per_Gallon',
10
color='Origin',
11
tooltip=['Name', 'Origin', 'Horsepower', 'Miles_per_Gallon']
12
).interactive()
13
14
report = dp.Report(
15
dp.Plot(plot1),
16
dp.DataTable(source)
17
)
18
19
# report.save(path='report.html', open=True)
20
.upload(name="My first report",
21
open = True,
22
description = "Testing out an Altair report")
Copied!
Once uploaded, you can share the link with others so they can view your report and comment on it. Public reports created are viewable and shareable by default. In future sections, we will also explore how to embed your report into a range of other platforms so you can share it with a wider audience.
Report Visibility and Sharing
Datapane Studio provides a free platform for uploading reports, with the following options for report visibility:
- 1.Default (unlisted): You have unlimited default reports, which allow anyone with the URL to access them, but they won't appear on your profile or in search results. This is not a truly private system, so make sure you aren't uploading very sensitive information.
- 2.Portfolio: You can also choose to add the report to your public portfolio (see example) which you can share with potential employers/readers. This is a great way to gain an audience and receive feedback on your reports!
- 3.Private: Your Community account comes with a limited number of private reports if you need to share data confidentially within your organization. Private reports are shared through the Report Notifications mechanism.
You can set these via the Report Settings page, or in Python as follows:
1
import datapane as dp
2
3
report = dp.Report(...)
4
5
# Default Report
6
report.upload(name='default report', visibility = dp.Visibility.DEFAULT)
7
8
# Portfolio Report
9
report.upload(name='portfolio report',visibility = dp.Visibility.PORTFOLIO)
10
11
# Private Report
12
report.upload(name='report',visibility = dp.Visibility.PRIVATE)
Copied!
Last modified 2mo ago
Copy link