---
metadata:
  - name: generator
    content: Diplodoc Platform v5.52.0
alternate:
  - https://ydb.tech/docs/en/integrations/gui/jupyter.md?version=v25.4
  - https://ydb.tech/docs/ru/integrations/gui/jupyter.md?version=v25.4
  - href: en/integrations/gui/jupyter.md
    type: text/markdown
    title: Markdown version
  - href: ../../llms.txt
    type: text/markdown
    title: llms.txt
sourcePath: en/core/integrations/gui/jupyter.md
---
> **Documentation Index:** Fetch the complete configuration index at https://ydb.tech/docs/en/llms.txt

# Work with YDB from Jupyter Notebook

[Jupyter Notebook](https://jupyter.org) is an open-source tool for creating shareable documents that combine code, plain language descriptions, data, rich visualizations, and interactive controls.

The [ydb-sqlalchemy dialect](https://github.com/ydb-platform/ydb-sqlalchemy/releases) enables working with YDB from tools such as:

* [Pandas](https://pandas.pydata.org/)
* [JupySQL](https://jupysql.ploomber.io/)

## Example

A detailed usage example is available as a [notebook](https://github.com/ydb-platform/ydb-sqlalchemy/blob/main/examples/jupyter_notebook/YDB%20SQLAlchemy%20%2B%20Jupyter%20Notebook%20Example.ipynb).

Prerequisites:

1. Python 3.8+
2. [Jupyter Notebook](https://jupyter.org/install#jupyter-notebook)
3. Existing YDB cluster, a single-node one from [quickstart](https://ydb.tech/docs/en/quickstart.md?version=v25.4) will suffice

To run the example, download the notebook file <!-- markdownlint-disable no-bare-urls -->{% file src="https://raw.githubusercontent.com/ydb-platform/ydb-sqlalchemy/refs/heads/main/examples/jupyter_notebook/YDB%20SQLAlchemy%20%2B%20Jupyter%20Notebook%20Example.ipynb" name="YDB SQLAlchemy - Jupyter Notebook Example.ipynb" %}, open it in Jupyter, and follow each cell sequentially, executing code as necessary.