Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/docs/scheduling/scheduling-versions.webp
Comment thread
petrfiedler marked this conversation as resolved.
Resolved
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/export-pdf.md
Comment thread
petrfiedler marked this conversation as resolved.
Resolved
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ You can export a notebook to PDF directly from the project toolbar in just a few

![Project context menu with Export as option](../assets/docs/export-pdf/project-context-menu.webp)

3. Hover over **Export as**.
3. Hover over **Export as ...**.
4. Choose **PDF with code** or **PDF without code**.

- **PDF with code** includes code cells in the exported PDF.
Expand Down
2 changes: 1 addition & 1 deletion docs/export-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ noIndex: false
noContent: false
---

To export a project, click the ellipses (`...`) to the right of the Share & publish button and then click on Download. The downloaded file is in zip format and contains your notebooks (in `.ipynb` format) as well as your other assets.
To export a project, click the ellipses (`...`) in the project toolbar, hover over **Export as ...**, and click **Project as .zip**. The downloaded file is in zip format and contains your notebooks (in `.ipynb` format) as well as your other assets.

<VideoLoop src="../assets/docs/f5pdf2VPRqWDvwDM74aY.mp4" />
Comment thread
petrfiedler marked this conversation as resolved.
Resolved
8 changes: 4 additions & 4 deletions docs/scheduling.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,17 @@ Deepnote makes it easy to take your explorations to production. For example:

### How to schedule a notebook

1. Click the calendar icon **Schedule notebook**, which is at the top of the notebook, right next to the **Run notebook** button
2. Configure the frequency at which you would like the notebook to run and then click **Save.**
1. Click the calendar icon **Schedule notebook**, which is at the top of the notebook, next to the **Run** button
2. Enable **Schedule notebook**, configure the frequency at which you want the notebook to run, and then click **Save schedule**.
3. Additionally, you can also configure notifications for successful and failed runs, either by email or into Slack.
Comment thread
petrfiedler marked this conversation as resolved.
Resolved

![Scheduling notifications.jpg](../assets/docs/5vnhJjTRfuHyBA0aJTNC.jpg)
![Scheduling notifications](../assets/docs/scheduling/scheduling-notifications.webp)

### How to know if your scheduled notebook ran successfully

If an exception is raised during the run, the run is considered failed; otherwise, it's successful. Please note that if an error is raised in a block, the subsequent blocks are not executed. Every run automatically creates a [run snapshot](/docs/run-snapshots) — an immutable record of the notebook's state after execution. You can review snapshots of successful and failed runs from the Runs sidebar or the project logs.

![Scheduling versions.jpg](../assets/docs/5NYCPGefRZScMa2R0l8S.jpg)
![Scheduling versions](../assets/docs/scheduling/scheduling-versions.webp)

<Callout status="info">
Schedules that fail repeatedly are automatically paused to avoid wasting compute on runs that keep erroring. You can review and re-enable a paused schedule from the scheduling settings.
Expand Down
25 changes: 8 additions & 17 deletions docs/streamlit.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,29 +14,23 @@ Get started by exploring our [example apps](https://deepnote.com/explore#streaml

There are two ways to get started with Streamlit in Deepnote:

1. Drop in existing scripts. Simply drag and drop your `.py` file into your project's **Files section**. Deepnote automatically detects Streamlit apps and begins deployment. In seconds, you'll see your live app in the split-screen preview.
1. Drop in existing scripts. Add your `.py` file to your project's **Files** panel in the right sidebar. Deepnote automatically detects Streamlit apps and begins deployment. In seconds, you'll see your live app in the split-screen preview.
2. Start from scratch. Create a new `.py` file and write your Streamlit code directly in Deepnote - from simple buttons to complex interactive elements. When ready, click the **Create Streamlit app** button in the upper right corner to deploy.

Once deployed, use the **Open app button** to see your app in its full shared state.

![streamlit map.png](../assets/docs/rvep2fghRAS3hc1kxjFn.webp)
Comment thread
petrfiedler marked this conversation as resolved.
Resolved

## App status

Your project's hardware serves your Streamlit apps. The indicator in the upper left corner of the app preview shows three possible states:
Your project's hardware serves your Streamlit apps. The indicator in the upper left corner of the app preview shows the current state:

- `Live`: App is deployed and running - visitors can interact immediately
- `Sleeping`: App is deployed but project hardware is inactive - visitors will wait for initialization
- `Deploying app`: App is updating and temporarily unavailable
- `Awake`: The app is deployed and running, so visitors can interact with it.
Comment thread
petrfiedler marked this conversation as resolved.
Resolved
- `Waking up`: The project hardware is starting and the app is not yet available.
- `Going to sleep`: The app is becoming unavailable as the project hardware shuts down.

## Editing an app

When you make changes to your app's code, your updates will be reflected immediately in the live app.

Note: this means anyone viewing your app will see these changes as they happen. If you prefer to control when updates go live, you can disable automatic updates in the Streamlit settings (hamburger icon, Settings) by turning off the **Run on save** option.
Comment thread
petrfiedler marked this conversation as resolved.
Resolved

![streamlit_run_on_save.png](../assets/docs/xdgPwHaXROa9tJnIguzg.webp)

## Sharing an app

To share your deployed app, click **Settings** and **Copy link**.
Expand All @@ -53,8 +47,6 @@ Streamlit apps often need data to visualize. Deepnote's notebook environment is

Need to update your data regularly? Take advantage of [notebook scheduling](https://deepnote.com/docs/scheduling) to automate your data preparation.

![streamlit_using_csv.png](../assets/docs/jPOfyMQzQqutYX3HNaWn.webp)
Comment thread
petrfiedler marked this conversation as resolved.
Resolved

## Using integrations

It is possible to use integrations connected to your project from a Streamlit app.
Expand Down Expand Up @@ -151,7 +143,6 @@ Your Streamlit app shares its environment with your project. If you need to add

## Limitations
Comment thread
petrfiedler marked this conversation as resolved.
Resolved

- AI support for editing Streamlit files is coming soon!
- The file upload widget in Streamlit apps is not working - fix is on the way.
- Some Streamlit built-in features have limited functionality:
- The **Record a screencast** feature is not available
- The Streamlit file editor includes an AI assistance panel.
- The file upload widget is supported in Streamlit apps.
- The app menu includes a **Record screen** option.
Comment thread
petrfiedler marked this conversation as resolved.
Resolved
Loading