1- ![ Deepnote VS Code cover image] ( deepnote-vscode-cover-image.png )
1+ <div align =" center " >
2+
3+ ![ Deepnote cover image] ( ./assets/deepnote-cover-image.png )
24
35[ ![ CI] ( https://github.com/deepnote/vscode-deepnote/actions/workflows/ci.yml/badge.svg?branch=main )] ( https://github.com/deepnote/vscode-deepnote/actions/workflows/ci.yml )
46[ ![ codecov] ( https://codecov.io/gh/deepnote/vscode-deepnote/graph/badge.svg?token=NH066XG7JC )] ( https://codecov.io/gh/deepnote/vscode-deepnote )
5- [ ![ License: MIT] ( https://img.shields.io/badge/License-MIT-yellow.svg )] ( https://opensource.org/licenses/MIT )
67[ ![ VS Code Marketplace] ( https://img.shields.io/badge/VS%20Code-Marketplace-blue )] ( https://marketplace.visualstudio.com/items?itemName=Deepnote.vscode-deepnote )
78
8- A powerful [ Visual Studio Code] ( https://marketplace.visualstudio.com/items?itemName=Deepnote.vscode-deepnote ) , [ Cursor] ( https://open-vsx.org/extension/Deepnote/vscode-deepnote ) and [ Windsurf] ( https://open-vsx.org/extension/Deepnote/vscode-deepnote ) 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.
9-
10- ---
11-
12- ![ Deepnote Projects] ( ./images/deepnote-projects.png )
9+ [ Website] ( https://deepnote.com/?utm_source=github&utm_medium=github&utm_campaign=github&utm_content=readme_main ) • [ Docs] ( https://deepnote.com/docs?utm_source=github&utm_medium=github&utm_campaign=github&utm_content=readme_main ) • [ Changelog] ( https://deepnote.com/changelog?utm_source=github&utm_medium=github&utm_campaign=github&utm_content=readme_main ) • [ X] ( https://x.com/DeepnoteHQ ) • [ Examples] ( https://deepnote.com/explore?utm_source=github&utm_medium=github&utm_campaign=github&utm_content=readme_main ) • [ Community] ( https://github.com/deepnote/deepnote/discussions )
1310
14- ---
15-
16- # 🚀 Deepnote in VS Code, Cursor and Windsurf - data notebook for AI era
11+ </div >
1712
18- Run Deepnote locally inside VS Code, Cursor and Windsurf — not Jupyter — and unlock the next generation of data workflows:
13+ # Deepnote in VS Code, Cursor and Windsurf
1914
20- - 🧠 ** SQL in VS Code** — Run SQL queries out of the box, no extensions needed
21- - 🧩 ** Rich block types** — Combine Python, Markdown, data visualizations, tables, and more — all in one place
22- - 🔐 ** Native database connections** — Securely connect to Snowflake, BigQuery, Postgres, and 60+ other sources via VS Code’s encrypted SecretStorage API
23- - ⚙️ ** Init notebooks** — Auto-run setup code (dependencies, env setup) before execution
24- - 📦 ** Smart requirements** — Generate ` requirements.txt ` automatically for reproducible runs
15+ A powerful [ Visual Studio Code] ( https://marketplace.visualstudio.com/items?itemName=Deepnote.vscode-deepnote ) , [ Cursor] ( https://open-vsx.org/extension/Deepnote/vscode-deepnote ) and [ Windsurf] ( https://open-vsx.org/extension/Deepnote/vscode-deepnote ) 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.
2516
26- 🐍 ** Jupyter kernel, upgraded **
17+ ![ Deepnote Projects ] ( ./assets/deepnote-projects.png )
2718
28- - ⚡ ** Deepnote kernel** — Fully ` .ipynb-compatible ` , tuned for modern data workflows
29- - 🔁 ** Kernel control** — Restart, interrupt, and switch seamlessly
3019
31- 🌐 ** Deepnote ecosystem integrations **
20+ Run Deepnote locally inside your IDE and unlock the next generation of data workflows:
3221
33- - 🔃 ** Auto-refresh** — Instantly detects file and data changes
34- - 🧮 ** Multi-notebook support** — Work across multiple notebooks in one unified project
35- - ☁ ** Cloud collaboration** — Switch between local VS Code and Deepnote Cloud to collaborate live on the same file with your team
22+ - ** Rich block types:** Combine Python, Markdown, data visualizations, tables, and more — all in one place
23+ - ** SQL blocks:** Run SQL queries out of the box, no extensions needed
24+ - ** Native database connections:** Securely connect to Snowflake, BigQuery, Postgres, and 60+ other sources via VS Code’s encrypted SecretStorage API
25+ - ** Init notebooks:** Auto-run setup code (dependencies, env setup) before execution
26+ - ** Smart requirements:** Generate ` requirements.txt ` automatically for reproducible runs
27+ - ** Deepnote kernel:** Fully ` .ipynb ` compatible, tuned for modern data workflows
28+ - ** Cloud collaboration:** Switch between local VS Code and Deepnote Cloud to collaborate live on the same file with your team
3629
37- ## 📋 Requirements
38-
39- - ** Visual Studio Code** 1.95.0 or higher
40- - ** Python** 3.10 or higher (for running notebooks)
41-
42- ## 🎯 Getting started
30+ ## Getting started
4331
44321 . Open the extensions tab and Search for Deepnote
45332 . Or alternatively, press ` Cmd+P ` or ` Ctrl+P ` to open the command palette.
@@ -48,6 +36,11 @@ Run Deepnote locally inside VS Code, Cursor and Windsurf — not Jupyter — and
4836
4937Or install from the [ VS Code Marketplace] ( https://marketplace.visualstudio.com/items?itemName=Deepnote.vscode-deepnote )
5038
39+ ### Requirements
40+
41+ - ** Visual Studio Code** 1.95.0 or higher
42+ - ** Python** 3.10 or higher (for running notebooks)
43+
5144### Opening your first Deepnote notebook
5245
53461 . Open a folder containing ` .deepnote ` project files
@@ -56,7 +49,7 @@ Or install from the [VS Code Marketplace](https://marketplace.visualstudio.com/i
56494 . Select a Python kernel when prompted
57505 . Start coding!
5851
59- ## 📖 Usage
52+ ## Usage
6053
6154### Command palette
6255
@@ -96,36 +89,22 @@ SELECT * FROM users WHERE created_at > '2024-01-01'
9689
9790Results are displayed as interactive tables that you can explore and export.
9891
99- ## 🛠️ Quick start for developers
100-
101- Want to contribute? Check out our [ Contributing Guide] ( CONTRIBUTING.md ) for detailed setup instructions.
102-
103- - Setting up your development environment
104- - Running tests
105- - Building the extension
106- - Submitting pull requests
107-
108- ## 📚 Documentation
109-
110- - ** [ Architecture] ( architecture.md ) ** - Technical architecture and design decisions
111- - ** [ Deepnote Kernel Implementation] ( DEEPNOTE_KERNEL_IMPLEMENTATION.md ) ** - Details on the custom Jupyter kernel
112- - ** [ Integrations & Credentials] ( INTEGRATIONS_CREDENTIALS.md ) ** - How database integrations work
113- - ** [ Contributing Guide] ( CONTRIBUTING.md ) ** - How to contribute to the project
114-
115- ## 📄 License
92+ ## Need help?
11693
117- This project is licensed under the MIT License - see the [ LICENSE] ( LICENSE ) file for details.
94+ - Join our [ Community] ( https://github.com/deepnote/deepnote/discussions ) !
95+ - Open an [ Issue] ( https://github.com/deepnote/vscode-deepnote/issues ) for bug reports or feature requests
96+ - Have a look at [ Architecture] ( architecture.md ) for technical and design decisions
97+ - Visit [ Deepnote kernel implementation] ( DEEPNOTE_KERNEL_IMPLEMENTATION.md ) for the custom Jupyter kernel
98+ - Learn how database integrations work in [ Integrations & credentials] ( INTEGRATIONS_CREDENTIALS.md )
11899
119- ## 🐛 Issues & support
100+ ## Contributing
120101
121- - ** Bug reports** : [ GitHub issues] ( https://github.com/deepnote/vscode-deepnote/issues )
122- - ** Feature requests** : [ GitHub discussions] ( https://github.com/deepnote/deepnote/discussions )
123- - ** Questions** : [ GitHub discussions] ( https://github.com/deepnote/deepnote/discussions )
102+ Want to contribute? Check out our [ Contributing guide] ( CONTRIBUTING.md ) for detailed setup instructions.
124103
125104---
126105
127106<div align =" center " >
128107
129- ** Built with 💙 by the Deepnote team **
108+ Built with 💙
130109
131110</div >
0 commit comments