Skip to content

Commit 837d120

Browse files
committed
docs: update of readme
1 parent fb8ecea commit 837d120

File tree

1 file changed

+35
-86
lines changed

1 file changed

+35
-86
lines changed

README.md

Lines changed: 35 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -5,58 +5,45 @@
55
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
66
[![VS Code Marketplace](https://img.shields.io/badge/VS%20Code-Marketplace-blue)](https://marketplace.visualstudio.com/items?itemName=Deepnote.vscode-deepnote)
77

8-
A powerful [Visual Studio Code](https://code.visualstudio.com/) extension that brings [Deepnote](https://deepnote.com/) notebook capabilities directly into your favorite editor. Work with enhanced data science notebooks featuring SQL blocks, database integrations, and collaborative features - all within VS Code.
9-
10-
## 🚀 Features
8+
A powerful [Visual Studio Code](https://code.visualstudio.com/) extension that brings [Deepnote](https://deepnote.com/) notebook capabilities directly into your favorite editor. Work with sleek AI notebooks featuring SQL blocks, database integrations, and reactive blocks - all within VS Code.
119

10+
---
1211
![Deepnote Projects](./images/deepnote-projects.png)
1312

14-
### Enhanced Notebook Experience
15-
16-
Deepnote notebooks extend traditional Jupyter notebooks with powerful data science features:
17-
18-
- **🔢 Multiple Block Types** - Work with Python code, SQL queries, Markdown documentation, and specialized data science blocks
19-
- **🔄 Seamless Language Switching** - Switch between Python and SQL within the same notebook without context switching
20-
- **🗄️ Database Integrations** - Connect directly to PostgreSQL, BigQuery, Snowflake, and other data sources with secure credential management
21-
- **⚡ Init Notebooks** - Automatically run initialization code (dependencies, environment setup) before notebook execution
22-
- **📦 Automatic Requirements** - Generate `requirements.txt` from your project settings for reproducible environments
23-
- **🎨 Rich Outputs** - View data visualizations, tables, and interactive outputs directly in VS Code
24-
- **🔐 Secure Credential Storage** - Safely store and manage database credentials using VS Code's encrypted SecretStorage API
25-
26-
### Jupyter Kernel Support
27-
28-
Built on top of robust Jupyter infrastructure:
29-
30-
- **🐍 Python Kernel** - Full Python support with IPython features
31-
- **🔌 Custom Deepnote Kernel** - Enhanced kernel with Deepnote-specific features and integrations
32-
- **📊 Interactive Debugging** - Debug notebooks cell-by-cell with VS Code's debugger
33-
- **🔄 Kernel Management** - Easy kernel selection, restart, and interrupt capabilities
34-
35-
### Project Management
36-
37-
- **📁 Project Explorer** - Browse and manage Deepnote projects directly from VS Code's sidebar
38-
- **📓 Multi-Notebook Support** - Work with multiple notebooks from the same project
39-
- **🔍 Quick Navigation** - Jump between notebooks and files with command palette integration
40-
- **♻️ Auto-Refresh** - Automatic detection of project file changes
13+
---
14+
# 🚀 Deepnote in VS Code - data notebook for AI era
15+
Run Deepnote locally inside VS Code — not Jupyter — and unlock the next generation of data workflows:
16+
- 🧠 **SQL in VS Code** — Run SQL queries out of the box, no extensions needed
17+
- 🧩 **Rich block types** — Combine Python, Markdown, data visualizations, tables, and more — all in one place
18+
- 🔐 **Native database connections** — Securely connect to Snowflake, BigQuery, Postgres, and 60+ other sources via VS Code’s encrypted SecretStorage API
19+
- ⚙️ **Init notebooks** — Auto-run setup code (dependencies, env setup) before execution
20+
- 📦 **Smart requirements** — Generate `requirements.txt` automatically for reproducible runs
21+
22+
🐍 **Jupyter kernel, upgraded**
23+
-**Deepnote kernel** — Fully `.ipynb-compatible`, tuned for modern data workflows
24+
- 🔁 **Kernel control** — Restart, interrupt, and switch seamlessly
25+
26+
🌐 **Deepnote ecosystem integrations**
27+
- 🔃 **Auto-refresh** — Instantly detects file and data changes
28+
- 🧮 **Multi-notebook support** — Work across multiple notebooks in one unified project
29+
-**Cloud collaboration** — Switch between local VS Code and Deepnote Cloud to collaborate live on the same file with your team
4130

4231
## 📋 Requirements
4332

4433
- **Visual Studio Code** 1.103.0 or higher
4534
- **Python** 3.8 or higher (for running notebooks)
4635
- **Node.js** 22.15.1 or higher (for development)
4736

48-
## 🎯 Getting Started
49-
50-
### Installation
37+
## 🎯 Getting started
5138

5239
1. Open VS Code
53-
2. Press `Ctrl+P` / `Cmd+P` to open Quick Open
40+
2. Press `Cmd+P` or `Ctrl+P` to open Quick Open
5441
3. Type `ext install Deepnote.vscode-deepnote`
5542
4. Press Enter
5643

5744
Or install from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=Deepnote.vscode-deepnote)
5845

59-
### Opening Your First Deepnote Notebook
46+
### Opening your first Deepnote notebook
6047

6148
1. Open a folder containing `.deepnote` project files
6249
2. Look for the Deepnote icon in the Activity Bar (sidebar)
@@ -66,9 +53,9 @@ Or install from the [VS Code Marketplace](https://marketplace.visualstudio.com/i
6653

6754
## 📖 Usage
6855

69-
### Command Palette
56+
### Command palette
7057

71-
Open the Command Palette (`Cmd+Shift+P` on macOS, `Ctrl+Shift+P` on Windows/Linux) and type `Deepnote` to see all available commands:
58+
Open the Command Palette (`Cmd+Shift+P` or `Ctrl+Shift+P`) and type `Deepnote` to see all available commands:
7259

7360
| Command | Description |
7461
| ---------------------------------- | -------------------------------------------------- |
@@ -82,7 +69,7 @@ Open the Command Palette (`Cmd+Shift+P` on macOS, `Ctrl+Shift+P` on Windows/Linu
8269
| `Notebook: Select Notebook Kernel` | Select or switch kernels within your notebook |
8370
| `Notebook: Change Cell Language` | Change the language of the cell currently in focus |
8471

85-
### Database Integrations
72+
### Database integrations
8673

8774
Configure database connections for SQL blocks:
8875

@@ -104,31 +91,9 @@ SELECT * FROM users WHERE created_at > '2024-01-01'
10491

10592
Results are displayed as interactive tables that you can explore and export.
10693

107-
## 🛠️ Development
94+
## 🛠️ Quick start for developers
10895

10996
Want to contribute? Check out our [Contributing Guide](CONTRIBUTING.md) for detailed setup instructions.
110-
111-
### Quick Start for Developers
112-
113-
```bash
114-
# Clone the repository
115-
git clone https://github.com/deepnote/vscode-deepnote.git
116-
cd vscode-deepnote
117-
118-
# Install dependencies
119-
npm install
120-
121-
# Setup pre-commit hooks
122-
npm run setup-precommit-hook
123-
124-
# Compile and watch for changes
125-
npm run watch
126-
127-
# Run tests
128-
npm run test:unittests
129-
```
130-
131-
See [CONTRIBUTING.md](CONTRIBUTING.md) for more details on:
13297
- Setting up your development environment
13398
- Running tests
13499
- Building the extension
@@ -141,36 +106,20 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for more details on:
141106
- **[Integrations & Credentials](INTEGRATIONS_CREDENTIALS.md)** - How database integrations work
142107
- **[Contributing Guide](CONTRIBUTING.md)** - How to contribute to the project
143108

144-
## 🤝 Contributing
145-
146-
We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details on:
147-
148-
- Code of conduct
149-
- Development setup
150-
- Coding standards
151-
- Pull request process
152-
- Testing requirements
153-
154109
## 📄 License
155110

156111
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
157112

158-
## 🐛 Issues & Support
113+
## 🐛 Issues & support
159114

160-
- **Bug Reports**: [GitHub Issues](https://github.com/deepnote/vscode-deepnote/issues)
161-
- **Feature Requests**: [GitHub Discussions](https://github.com/deepnote/vscode-deepnote/discussions)
162-
- **Questions**: [GitHub Discussions](https://github.com/deepnote/vscode-deepnote/discussions)
115+
- **Bug reports**: [GitHub issues](https://github.com/deepnote/vscode-deepnote/issues)
116+
- **Feature requests**: [GitHub discussions](https://github.com/deepnote/deepnote/discussions)
117+
- **Questions**: [GitHub discussions](https://github.com/deepnote/deepnote/discussions)
163118

164-
## 🔗 Related Projects
119+
## 🔗 Try Deepnote for free at:
165120

166121
- [Deepnote](https://deepnote.com/) - Collaborative data science notebook platform
167-
- [Jupyter](https://jupyter.org/) - Open-source notebook ecosystem
168-
- [VS Code Python Extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) - Python language support for VS Code
169-
170-
## 🌟 Keywords
171-
172-
`deepnote` `jupyter` `notebook` `data-science` `python` `sql` `database` `postgresql` `bigquery` `vscode-extension` `data-analysis` `machine-learning` `interactive-computing` `ipython` `jupyter-notebook` `collaborative-notebooks`
173-
174-
---
175-
176-
Made with ❤️ by the Deepnote team
122+
- [VS Code Extension for Deepnote](https://marketplace.visualstudio.com/items?itemName=Deepnote.vscode-deepnote) - Python language support for VS Code
123+
- [Cursor extesion for Deepnote](https://open-vsx.org/extension/Deepnote/vscode-deepnote)
124+
- [Windsurf extension for Deepnote](https://open-vsx.org/extension/Deepnote/vscode-deepnote)
125+
Made with 💙 by the Deepnote team

0 commit comments

Comments
 (0)