Skip to content
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 27 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,35 @@
<div align="center">

![Deepnote Toolkit cover image](https://landing-assets.deepnote.com/deepnote-toolkit-cover-image.png)

[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)
![Deepnote cover image](./assets/deepnote-cover-image.png)

[![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)
[![codecov](https://codecov.io/gh/deepnote/deepnote-toolkit/graph/badge.svg?token=JCRUJP2BB9)](https://codecov.io/gh/deepnote/deepnote-toolkit)

[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)


</div>

Deepnote Toolkit is a set of tools to power [Deepnote data workspaces](https://deepnote.com/docs/workspaces).
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.
# Deepnote Toolkit: SQL, charts, and notebook utilities

Deepnote Toolkit powers [Deepnote Cloud](https://deepnote.com) and [Deepnote Open Source](https://github.com/deepnote/deepnote).
It starts and manages Jupyter, Streamlit, and LSP servers, and provides runtime integrations for fast and reliable experience.

## Features

- **Python kernel with scientific computing libraries preinstalled**, allowing you to focus on work instead of fighting with Python dependencies
- **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))*
- **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?utm_source=github&utm_medium=github&utm_campaign=github&utm_content=readme_main))
- **Visualize data with chart blocks**, using Vega, along with additional support for Altair and Plotly
- Native **Deepnote component library** including beautiful `DataFrame` rendering and interactive inputs
- **Visualize data with Vega**, along with additional support for Altair and Plotly
- **Python kernel with curated set of libraries preinstalled**, allowing you to focus on work instead of fighting with Python dependencies
- Run multiple **interactive applications built with Streamlit**
- Language Server Protocol integration for code completion and intelligence
- Git integration with SSH/HTTPS authentication

## Installation
## How to install Deepnote Toolkit

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).
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).

To start Deepnote Toolkit locally, first install it via `pip` or your favorite package manager:
To start Deepnote Toolkit locally, install via `pip` or your favorite package manager:

```sh
pip install deepnote-toolkit
Expand All @@ -39,9 +42,9 @@ pip install deepnote-toolkit[server]
```


## CLI quickstart
## How to run Deepnote Toolkit

To run Toolkit locally after installation use:
To run Deepnote Toolkit after installation use:

```bash
# show all available commands
Expand All @@ -58,27 +61,24 @@ deepnote-toolkit config show
deepnote-toolkit config set server.jupyter_port 9000
```

**Security Note**: The CLI will warn if Jupyter runs without authentication. For local development only. Set `DEEPNOTE_JUPYTER_TOKEN` for shared environments.
**Security note**: The CLI will warn if Jupyter runs without authentication. For local development only. Set `DEEPNOTE_JUPYTER_TOKEN` for shared environments.

## Need help?

- Join our [Community](https://github.com/deepnote/deepnote/discussions)!
- [Open an issue](https://github.com/deepnote/deepnote-toolkit/issues) for bug reports or feature requests
- Check out our [documentation](https://deepnote.com/docs)
- Learn how to report security vulnerabilities via [security](SECURITY.md)
- Want a low-code experience? Visit [Deepnote Cloud](https://deepnote.com) together with Deepnote AI agent

## Contributing

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

## License

Apache License 2.0 (see [LICENSE](LICENSE) for details)

## Support

- **Documentation**: [docs.deepnote.com](https://docs.deepnote.com)
- **Issues**: [GitHub Issues](https://github.com/deepnote/deepnote-toolkit/issues)
- **Security**: See [security guideline](SECURITY.md) for reporting vulnerabilities


<hr>
---
<div align="center">

Built with 💙 by the Deepnote team
Built with 💙

</div>
Binary file added assets/deepnote-cover-image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.