Skip to content

Commit 2ef77fd

Browse files
committed
docs: update readme
1 parent 976da84 commit 2ef77fd

File tree

1 file changed

+27
-73
lines changed

1 file changed

+27
-73
lines changed

README.md

Lines changed: 27 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![Deepnote dragon](deepnote_dragon.png)
1+
![Deepnote dragon](deepnote-dragon.png)
22
<!---This is a placeholder for the Deepnote + jupyterlab logo-->
33

44
<div align="center">
@@ -9,25 +9,22 @@
99
[![Python Version](https://img.shields.io/pypi/pyversions/jupyterlab-deepnote.svg)](https://pypi.org/project/jupyterlab-deepnote/)
1010
[![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
1111

12-
**A JupyterLab extension for viewing Deepnote projects (`.deepnote` files) directly in JupyterLab**
12+
## A JupyterLab extension for viewing Deepnote projects (`.deepnote` files) directly in JupyterLab
1313

14-
[Installation](#installation)[Features](#features)[Usage](#usage)[Contributing](#contributing)[License](#license)
14+
[Installation](#installation)[Features](#features)[Usage](#usage)[Contributing](#contributing)[License](#license)[Deepnote](https://deepnote.com)[GitHub comunity](https://github.com/deepnote/deepnote)
1515

1616
</div>
1717

1818
---
19+
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.
1920

20-
## Overview
21+
### Key features
2122

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.
23-
24-
### Key Features
25-
26-
- 📂 **Open Deepnote Files**: View `.deepnote` project files containing Deepnote notebooks in JupyterLab
27-
- 📓 **Multi-Notebook Support**: Switch between multiple notebooks within a single `.deepnote` file
28-
- 👁️ **Read-Only Mode**: View notebook content safely without modifying the original `.deepnote` file
29-
- 🔄 **Seamless Integration**: Works natively with JupyterLab's notebook interface
30-
- 🎨 **Deepnote Block Support**: Renders Deepnote-specific block types as Jupyter cells
23+
- 📂 **Open Deepnote files**: View `.deepnote` project files containing Deepnote notebooks in JupyterLab
24+
- 📓 **Multi-notebook support**: Switch between multiple notebooks within a single `.deepnote` file
25+
- 👁️ **Read-only mode**: View notebook content safely without modifying the original `.deepnote` file
26+
- 🔄 **Seamless integration**: Works natively with JupyterLab's notebook interface
27+
- 🎨 **Deepnote block support**: Renders Deepnote-specific block types as Jupyter cells
3128

3229
## Installation
3330

@@ -38,15 +35,15 @@
3835

3936
### Install via pip
4037

41-
Install the extension using pip:
38+
Install the extension using pip, see our [PyPI page](https://pypi.org/project/jupyterlab-deepnote/):
4239

4340
```bash
44-
pip install jupyterlab_deepnote
41+
pip install jupyterlab-deepnote
4542
```
4643

4744
The extension will be automatically enabled after installation.
4845

49-
### Verify Installation
46+
### Verify installation
5047

5148
Check that the extension is properly installed and enabled:
5249

@@ -62,7 +59,7 @@ You should see `jupyterlab_deepnote` listed in both outputs.
6259

6360
## Usage
6461

65-
### Opening Deepnote Files
62+
### Opening Deepnote files
6663

6764
1. **Launch JupyterLab**:
6865
```bash
@@ -73,38 +70,22 @@ You should see `jupyterlab_deepnote` listed in both outputs.
7370
- Use the file browser to navigate to your `.deepnote` file
7471
- Double-click the file to open it in the notebook viewer
7572

76-
3. **Switch Between Notebooks** (if the `.deepnote` file contains multiple notebooks):
73+
3. **Switch between notebooks** (if the `.deepnote` file contains multiple notebooks):
7774
- Use the notebook picker dropdown in the toolbar
7875
- Select the notebook you want to view
7976

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-
9677
## Architecture
9778

9879
This extension consists of two main components:
9980

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
10283

10384
The extension uses a custom content provider to intercept `.deepnote` file requests and transform them into Jupyter-compatible notebook content.
10485

10586
## Troubleshooting
10687

107-
### Extension Not Loading
88+
### Extension not loading
10889

10990
If the extension doesn't appear to be working:
11091

@@ -124,13 +105,13 @@ If the extension doesn't appear to be working:
124105
jupyter lab --debug
125106
```
126107

127-
### Common Issues
108+
### Common issues
128109

129110
- **`.deepnote` files not opening**: Ensure the file extension is exactly `.deepnote`
130111
- **Missing notebooks**: Verify the `.deepnote` file contains valid YAML-formatted Deepnote project data
131112
- **Extension conflicts**: Try disabling other notebook-related extensions temporarily
132113

133-
### Getting Help
114+
### Getting help
134115

135116
If you encounter issues:
136117
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.
151132

152133
For development setup, testing, and contributing guidelines, please see [CONTRIBUTING.md](CONTRIBUTING.md).
153134

154-
### Quick Start for Contributors
155-
156-
```bash
157-
# Clone the repository
158-
git clone https://github.com/deepnote/jupyterlab-deepnote.git
159-
cd jupyterlab-deepnote
160-
161-
# Install in development mode
162-
pip install -e ".[test]"
163-
jupyter labextension develop . --overwrite
164-
165-
# Watch for changes
166-
jlpm watch
167-
```
168-
169-
## Contributing
170-
171-
We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for:
172-
- Development setup instructions
173-
- Code style and testing requirements
174-
- Pull request process
175-
- Release workflow
176-
177135
## License
178136

179137
This project is licensed under the BSD 3-Clause License - see the [LICENSE](LICENSE) file for details.
180138

181-
## Acknowledgments
182-
183-
- Built with the [JupyterLab Extension Template](https://github.com/jupyterlab/extension-template)
184-
- Developed by [Deepnote](https://deepnote.com)
139+
## Related projects
185140

186-
## Related Projects
187-
188-
- [Deepnote](https://deepnote.com) - Collaborative data science notebook
189-
- [JupyterLab](https://jupyterlab.readthedocs.io/) - Extensible environment for interactive computing
141+
- [Deepnote](https://deepnote.com)
142+
- [Deepnote Open Source](https://github.com/deepnote/deepnote)
143+
- [VS Code extension](https://marketplace.visualstudio.com/items?itemName=Deepnote.vscode-deepnote)
144+
- [Cursor extension](https://open-vsx.org/extension/Deepnote/vscode-deepnote)
145+
- [Windsurf extension](https://open-vsx.org/extension/Deepnote/vscode-deepnote)
190146

191147
---
192148

193149
<div align="center">
194150

195-
**[⬆ Back to Top](#jupyterlab-deepnote-extension)**
196-
197-
Made with ❤️ by the Deepnote team
151+
Made with 💙 by the Deepnote team
198152

199153
</div>

0 commit comments

Comments
 (0)