Skip to content

Commit 059d347

Browse files
authored
Merge pull request #18 from deepnote/filipzitny/mar-350-fix-inconsistencies-across-the-readmes
docs: update readme
2 parents f5a2f7d + 3029f4c commit 059d347

File tree

2 files changed

+27
-27
lines changed

2 files changed

+27
-27
lines changed

README.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,35 @@
11
<div align="center">
22

3-
![Deepnote Toolkit cover image](https://landing-assets.deepnote.com/deepnote-toolkit-cover-image.png)
4-
5-
[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)[Blog](https://deepnote.com/blog?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)
3+
![Deepnote cover image](./assets/deepnote-cover-image.png)
64

75
[![CI](https://github.com/deepnote/deepnote-toolkit/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/deepnote/deepnote-toolkit/actions/workflows/ci.yml)
86
[![codecov](https://codecov.io/gh/deepnote/deepnote-toolkit/graph/badge.svg?token=JCRUJP2BB9)](https://codecov.io/gh/deepnote/deepnote-toolkit)
97

8+
[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)
9+
10+
1011
</div>
1112

12-
Deepnote Toolkit is a set of tools to power [Deepnote data workspaces](https://deepnote.com/docs/workspaces).
13-
It is responsible for starting and managing servers (Jupyter, Streamlit, LSP), as well as providing runtime integrations for a hassle-free experience when it comes to all your data needs.
13+
# Deepnote Toolkit: SQL, charts, and notebook utilities
14+
15+
Deepnote Toolkit powers [Deepnote Cloud](https://deepnote.com) and [Deepnote Open Source](https://github.com/deepnote/deepnote).
16+
It starts and manages Jupyter, Streamlit, and LSP servers, and provides runtime integrations for fast and reliable experience.
1417

1518
## Features
1619

17-
- **Python kernel with scientific computing libraries preinstalled**, allowing you to focus on work instead of fighting with Python dependencies
18-
- **First-class SQL authoring and execution** without overhead of database connectors and SDKs *(all supported integrations with data warehouses, databases, cloud storages, and many other tools are listed in [documentation](https://deepnote.com/docs/getting-started))*
20+
- **First-class SQL authoring and execution** without overhead of database connectors and SDKs (all supported integrations with data warehouses, databases, cloud storages, and many other tools listed in [documentation](https://deepnote.com/docs?utm_source=github&utm_medium=github&utm_campaign=github&utm_content=readme_main))
21+
- **Visualize data with chart blocks**, using Vega, along with additional support for Altair and Plotly
1922
- Native **Deepnote component library** including beautiful `DataFrame` rendering and interactive inputs
20-
- **Visualize data with Vega**, along with additional support for Altair and Plotly
23+
- **Python kernel with curated set of libraries preinstalled**, allowing you to focus on work instead of fighting with Python dependencies
2124
- Run multiple **interactive applications built with Streamlit**
2225
- Language Server Protocol integration for code completion and intelligence
2326
- Git integration with SSH/HTTPS authentication
2427

25-
## Installation
28+
## How to install Deepnote Toolkit
2629

27-
Although Deepnote Toolkit can be run as a Python package via the CLI, we highly recommend first trying Deepnote via our [OSS offerings](https://github.com/deepnote/deepnote) including our VS Code, Cursor and Windsurf extensions or registering for the SaaS version at [deepnote.com](https://deepnote.com).
30+
Deepnote Toolkit can be run as a Python package via the CLI, you can also try Deepnote via our [open sourced repositories](https://github.com/deepnote/) including our VS Code, Cursor and Windsurf extensions or via [Deepnote Cloud](https://deepnote.com).
2831

29-
To start Deepnote Toolkit locally, first install it via `pip` or your favorite package manager:
32+
To start Deepnote Toolkit locally, install via `pip` or your favorite package manager:
3033

3134
```sh
3235
pip install deepnote-toolkit
@@ -39,9 +42,9 @@ pip install deepnote-toolkit[server]
3942
```
4043

4144

42-
## CLI quickstart
45+
## How to run Deepnote Toolkit
4346

44-
To run Toolkit locally after installation use:
47+
To run Deepnote Toolkit after installation use:
4548

4649
```bash
4750
# show all available commands
@@ -58,27 +61,24 @@ deepnote-toolkit config show
5861
deepnote-toolkit config set server.jupyter_port 9000
5962
```
6063

61-
**Security Note**: The CLI will warn if Jupyter runs without authentication. For local development only. Set `DEEPNOTE_JUPYTER_TOKEN` for shared environments.
64+
**Security note**: The CLI will warn if Jupyter runs without authentication. For local development only. Set `DEEPNOTE_JUPYTER_TOKEN` for shared environments.
65+
66+
## Need help?
67+
68+
- Join our [Community](https://github.com/deepnote/deepnote/discussions)!
69+
- [Open an issue](https://github.com/deepnote/deepnote-toolkit/issues) for bug reports or feature requests
70+
- Check out our [documentation](https://deepnote.com/docs)
71+
- Learn how to report security vulnerabilities via [security](SECURITY.md)
72+
- Want a low-code experience? Visit [Deepnote Cloud](https://deepnote.com) together with Deepnote AI agent
6273

6374
## Contributing
6475

6576
For more details on how to set up the local development environment and contribute,
6677
see [contributing guide](./CONTRIBUTING.md).
6778

68-
## License
69-
70-
Apache License 2.0 (see [LICENSE](LICENSE) for details)
71-
72-
## Support
73-
74-
- **Documentation**: [docs.deepnote.com](https://docs.deepnote.com)
75-
- **Issues**: [GitHub Issues](https://github.com/deepnote/deepnote-toolkit/issues)
76-
- **Security**: See [security guideline](SECURITY.md) for reporting vulnerabilities
77-
78-
79-
<hr>
79+
---
8080
<div align="center">
8181

82-
Built with 💙 by the Deepnote team
82+
Built with 💙
8383

8484
</div>

assets/deepnote-cover-image.png

943 KB
Loading

0 commit comments

Comments
 (0)