<h3 align="center">Pretzel 🥨</h3> Modern, open-source Jupyter alternative. <a href="https://pretzelai.app" target="_blank">Try it here »</a> <a href="https://discord.gg/bYNEgbPzRy" target="_blank">Discord</a> · <a href="https://withpretzel.com" target="_blank">Website</a> · <a href="https://github.com/pretzelai/pretzelai/issues">Issues</a> · <a href="mailto:founders@withpretzel.com" target="_blank">Contact</a> <a href="https://github.com/pretzelai/pretzelai/stargazers" target="_blank"><img src="https://img.shields.io/github/stars/pretzelai/pretzelai" alt="Github Stars"></a> <a href="https://pypi.org/project/pretzelai/" target="_blank"><img src="https://img.shields.io/pypi/v/pretzelai.svg?style=flat-square&label=PyPI+PretzelAI" alt="Issues"></a> <a href="https://discord.gg/bYNEgbPzRy" target="_blank"><img src="https://img.shields.io/badge/Discord-PretzelAI-blue?logo=discord" alt="Join Pretzel on Discord"></a> <a href="https://github.com/pretzelai/pretzelai/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-AGPLv3-purple" alt="License"></a> <a href="https://github.com/pretzelai/pretzelai/pulse"><img src="https://img.shields.io/github/commit-activity/m/pretzelai/pretzelai" alt="Commits-per-month"></a>

https://github.com/pretzelai/pretzelai/assets/121360087/ff4643b1-c931-410e-aa0b-9233e0766223

Pretzel is a fork of Jupyter with the goal to improve Jupyter's capabilities. We've added AI code generation and editing, inline tab completion, sidebar chat and error fixing to Jupyter for now with a lot more to come.

Switching to Pretzel from Jupyter is extremely easy since it's simply an improved version of Jupyter. All of your Jupyter config, settings, keybindings, and extensions will work out of the box.

Quick Start

Installation: pip install pretzelai then run pretzel lab to open the web interface. OR, use our free hosted version: pretzelai.app
- See this if you get errors during installation
Simply start typing in a cell to get inline tab completions
In any Jupyter cell, click “Ask AI” or press Cmd+K (Mac) / Ctrl+K (Linux/Windows) to prompt AI
Use the AI Sidebar with Ctrl+Cmd+B (Mac) or Ctrl+Alt+B (Linux/Windows) to chat with AI, generate code, and ask questions.
Type @ to trigger auto-complete with function and variable names.
To use your own model (OpenAI, Anthropic/Claude, Ollama or Groq), see the Configuration section

Our roadmap includes building features such as:

Native AI code generation and understanding features similar to Cursor
Frictionless realtime collaboration: pair-programming, comments, version history, etc.
SQL support (both in code cells and as a standalone SQL IDE)
Visual analysis builder (see more here)
VSCode like code-writing experience using Monaco
1-click dashboard creation and sharing from Jupyter notebooks

Installation

Using pip

Install Pretzel with pip

pip install pretzelai

For conda, install pip first with conda install pip and then pip install pretzelai.

Then, start Pretzel with:

pretzel lab

You'll be able to access the Pretzel interface via the provided URL.

To use your own AI model, see the Configuration section.

Running within a docker container

If you're having trouble installing Pretzel (for eg on Windows), you can run it in a Docker container.

Create a Dockerfile:

FROM python:3.9-slim
RUN apt-get update && apt-get install -y \
    build-essential \
    gcc \
    && rm -rf /var/lib/apt/lists/*
WORKDIR /root/pretzel
RUN pip install pretzelai
EXPOSE 8888
CMD ["pretzel", "lab", "--ip=0.0.0.0", "--allow-root", "--notebook-dir=/root/pretzel", "--ServerApp.allow_remote_access=True", "--ServerApp.token=''", "--no-browser"]

In the same folder where you have your Dockerfile, run docker build -t pretzel .
To run pretzel, you can run: docker run --name pretzel -p 8888:8888 pretzel and once the container is running, you can access it at http://localhost:8888/lab. To stop the container, press Ctrl + C followed by docker stop pretzel.

If you want to access your local folder in Pretzel, you can run: docker run --rm -p 8888:8888 -v $(pwd):/root/pretzel pretzel - this will map your current directory to the docker container's /root/pretzel folder. Make sure Docker has access to your current directory.

To update Pretzel to the latest version, just rebuild the Docker image with the --no-cache flag: docker build --no-cache -t pretzel . and now you can run docker like step 3.

Bleeding Edge Version

You can use this Dockerfile to build and run the bleeding edge version. Follow the steps (starting at step 2) in the section Running within a docker container

Installation problems

If you get an error during installation that looks like this:

Failed to build installable wheels for some pyproject.toml based projects (pystemmer)

That means the installation failed to install the dependency PyStemmer. This usually happens because you don't have the right build tools installed. To fix this:

On Windows: Install Miscrosoft build tools from here. Click on the Download Build Tools button and then install it.
On Ubuntu (and Debian flavoured systems): Install the required build tools by running the following command in your terminal:
```
sudo apt-get update && sudo apt-get install build-essential python3-dev
```
On macOS: brew install gcc. If this doesn't work, you may also need to run xcode-select --install

Once this is done, you should be able to pip install pretzelai to install Pretzel.

Usage

Inline Tab Completion

Start typing in a cell to get inline tab completions
Wait for 1 second to trigger completions. You'll see a little spinner just before the blue Ask AI button in the cell

The default Pretzel AI Server uses Mistral's Codestral but you can switch the inline completion model in Pretzel AI Settings. See the configuration section.

Generating and editing code in notebook cells

In a cell, press Cmd+K (Mac) / Ctrl+K (Windows/Linux) or click "Ask AI" to open AI prompt textbox and write your code generation/editing instruction
- Type @ to get a dropdown of available variables in your session. Adding this @vairable to the prompt will send its value to the AI
- We automatically send relevant code in the current notebook as context to the AI
If there's existing code in a cell, the prompt will edit the existing code
- If you select/highlight some code in the cell, only the selected code will be edited
You can accept/reject the response or edit your prompt if you want to re-submit with modifications
Use ↑ / ↓ to cycle through prompt history

Using the AI Sidebar

Use Ctrl+Cmd+B (Mac) / Ctrl+Alt+B (Linux/Windows) or the Pretzel Icon on the right sidebar to activate the AI Sidebar
You can ask questions, generate code, or search for existing code
The AI always uses the code in the active cell as context. If you highlight some code in the active cell, only the highlighted code will be used as context
We automatically send relevant code in the current notebook as context to the AI
You can also use the @ syntax to refer to variables and dataframes in memory, similar to the notebook cells

Example uses of AI Sidebar:

"Modify the function my_function to be more efficient" ← this will find the function my_function in the whole notebook and modify it
"Where is the code that removes outliers"? ← this will search the notebook for code that removes outliers and show it to you
(While cursor is in a cell with some code) "Can you explain what this code does?" ← this will explain the code in the current cell
"Plot a histogram of @df for age" ← this will generate code to plot a histogram of the 'age' column from the dataframe named 'df'
"Calculate the mean revenue in @salesdata for each product type" ← _this will generate code to calculate mean revenue by product type using the sales_data dataframe

Adding code in the middle of existing code

Put your cursor either on an empty line or an existing line of code. Bring up the AI prompting text box with Cmd+K
Start your prompt with the word inject or ij (case-insensitive) - this tells the AI to only add new code and not edit the existing code in the cell
Code will be added one line below where your cursor was placed

Fix errors with AI

When there's an error, you'll see a button on top-right "Fix Error with AI". Click it try fixing the error

Configuration

Pretzel works out-of-the-box, no configuration needed. We DO NOT store any code or data you send to the Pretzel AI Server.

Still, if you want to use a different AI model, you can configure Pretzel to use AI models from multiple different vendors, including local models. In this case, the AI request goes directly from your computer to the AI service (OpenAI, Anthropic etc).

Open the Settings menu in the top menubar, then click Pretzel AI Settings
Under AI Settings you can pick which AI models to use for chat and for inline completion (see screenshot below)
- We recommend using GPT-4 class models (e.g., GPT-4 Turbo, GPT-4o, Claude-3.5 Sonnet, Claude-3 Opus and Llama-3.1 405

Pretzelai

Install / Use

README