You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Deepnote is a data notebook for AI era. `jupyterlab-deepnote` is a JupyterLab extension that enables you to open and view [Deepnote](https://deepnote.com) project files (`.deepnote` format) directly within JupyterLab. This extension provides a seamless read-only viewer for Deepnote notebooks, allowing you to explore Deepnote projects without leaving your JupyterLab environment.
19
20
20
-
##Overview
21
+
### Key features
21
22
22
-
`jupyterlab-deepnote` is a JupyterLab extension that enables you to open and view [Deepnote](https://deepnote.com) project files (`.deepnote` format) directly within JupyterLab. This extension provides a seamless read-only viewer for Deepnote notebooks, allowing you to explore Deepnote projects without leaving your JupyterLab environment.
Install the extension using pip, see our [PyPI page](https://pypi.org/project/jupyterlab-deepnote/):
42
39
43
40
```bash
44
-
pip install jupyterlab_deepnote
41
+
pip install jupyterlab-deepnote
45
42
```
46
43
47
44
The extension will be automatically enabled after installation.
48
45
49
-
### Verify Installation
46
+
### Verify installation
50
47
51
48
Check that the extension is properly installed and enabled:
52
49
@@ -62,7 +59,7 @@ You should see `jupyterlab_deepnote` listed in both outputs.
62
59
63
60
## Usage
64
61
65
-
### Opening Deepnote Files
62
+
### Opening Deepnote files
66
63
67
64
1.**Launch JupyterLab**:
68
65
```bash
@@ -73,38 +70,22 @@ You should see `jupyterlab_deepnote` listed in both outputs.
73
70
- Use the file browser to navigate to your `.deepnote` file
74
71
- Double-click the file to open it in the notebook viewer
75
72
76
-
3.**Switch Between Notebooks** (if the `.deepnote` file contains multiple notebooks):
73
+
3.**Switch between notebooks** (if the `.deepnote` file contains multiple notebooks):
77
74
- Use the notebook picker dropdown in the toolbar
78
75
- Select the notebook you want to view
79
76
80
-
### Features in Detail
81
-
82
-
#### Read-Only Viewing
83
-
All content is displayed in read-only mode. You cannot:
84
-
- Edit cell content
85
-
- Execute cells
86
-
- Save changes back to the `.deepnote` file
87
-
88
-
This ensures the integrity of your original Deepnote project files.
89
-
90
-
#### Supported Content
91
-
The extension converts Deepnote blocks to Jupyter cells, supporting:
92
-
- Code cells (Python and other languages)
93
-
- Markdown cells
94
-
- Cell outputs and visualizations
95
-
96
77
## Architecture
97
78
98
79
This extension consists of two main components:
99
80
100
-
-**Server Extension**: Handles `.deepnote` file parsing and conversion to Jupyter notebook format
101
-
-**Frontend Extension**: Provides the JupyterLab UI integration and notebook picker widget
81
+
-**Server extension**: Handles `.deepnote` file parsing and conversion to Jupyter notebook format. Not all the blocks are supported; visit [docs](https://deepnote.com/docs/deepnote-blocks) to learn more
82
+
-**Frontend extension**: Provides the JupyterLab UI integration and notebook picker widget
102
83
103
84
The extension uses a custom content provider to intercept `.deepnote` file requests and transform them into Jupyter-compatible notebook content.
104
85
105
86
## Troubleshooting
106
87
107
-
### Extension Not Loading
88
+
### Extension not loading
108
89
109
90
If the extension doesn't appear to be working:
110
91
@@ -124,13 +105,13 @@ If the extension doesn't appear to be working:
124
105
jupyter lab --debug
125
106
```
126
107
127
-
### Common Issues
108
+
### Common issues
128
109
129
110
-**`.deepnote` files not opening**: Ensure the file extension is exactly `.deepnote`
130
111
-**Missing notebooks**: Verify the `.deepnote` file contains valid YAML-formatted Deepnote project data
131
112
-**Extension conflicts**: Try disabling other notebook-related extensions temporarily
132
113
133
-
### Getting Help
114
+
### Getting help
134
115
135
116
If you encounter issues:
136
117
1. Check the [GitHub Issues](https://github.com/deepnote/jupyterlab-deepnote/issues) for similar problems
@@ -151,49 +132,22 @@ After uninstalling, restart JupyterLab for the changes to take effect.
151
132
152
133
For development setup, testing, and contributing guidelines, please see [CONTRIBUTING.md](CONTRIBUTING.md).
0 commit comments