Metadata-Version: 2.1
Name: ai-einblick-prompt
Version: 0.1.11
Summary: Generative AI tool made for data tasks. Generate, modify, and fix code.
Project-URL: Homepage, https://www.einblick.ai/ai-einblick-prompt/
Project-URL: Bug Tracker, https://github.com/einblick-ai/jupyterlab-ext/issues
Project-URL: Repository, https://github.com/einblick-ai/jupyterlab-ext.git
Author-email: Einblick <nb@einblick.ai>
License: BSD 3-Clause License
        
        Copyright (c) 2023, Einblick
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License-File: LICENSE
Classifier: Framework :: Jupyter
Classifier: Framework :: Jupyter :: JupyterLab
Classifier: Framework :: Jupyter :: JupyterLab :: 4
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.8
Description-Content-Type: text/markdown

# ai-einblick-prompt

`ai-einblick-prompt` empowers JupyterLab users with a domain-specific AI agent that can generate, modify, and fix code for data science workflows. Einblick's extension is the easiest and only context-aware way to augment the data workflow with generative AI.

## [Einblick Prompt AI](https://www.einblick.ai/ai-einblick-prompt/)

Einblick is the AI-native data notebook that can write and fix code, create beautiful charts, build models, and much more. This is made possible via our domain-specific AI agent, Einblick Prompt. Visit our [homepage](https://www.einblick.ai/) to learn more about Einblick.

## Usage

[Watch a quick video tutorial.](https://cdn.sanity.io/files/1xvnv7n3/production/3af4d02af053694730f15c9be93234470dfa4e4e.mp4)

### Quick Start

1. Start JupyterLab and install `ai-einblick-prompt` via the Extension Manager in the left panel.
2. Read in a dataset.
3. Click the Einblick logo icon in the top-right side of any Python cell, and select “Generate.”
4. Ask Einblick Prompt AI to write code.

### Example Prompts

1. “Create a box plot of col_3.”
2. “Filter for cat_1, cat_2, and cat_3.”
3. “Create a scatter plot of col_1 vs. col_2, color by col_4.”

### Keyboard shortcut

`Command (⌘) + K` / `Ctrl + K` - Toggle prompt widget on active cell.

### Commands

The following commands are executable from the Jupyterlab command palette (`Command (⌘) + Shift + C` / `Ctrl + Shift + C`)

- **Einblick AI: Prompt**: Toggle prompt widget on active cell.
- **Einblcik AI: Generate**: Toggle "Generate" prompt on active cell to create new code for the cell.
- **Einblcik AI: Generate**: Toggle "Fix" prompt on active cell to fix errors in the cell.
- **Einblcik AI: Generate**: Toggle "Modify" prompt on active cell to change existing code in the cell.

## Installation Steps

### Requirements

- JupyterLab >= 4.0.0

### Install

**Method 1** Search `ai-einblick-prompt` in JupyterLab's Extension Manager, and click Install

**Method 2** Execute:

```bash
pip install ai-einblick-prompt
```

### Uninstall

To remove the extension, execute:

```bash
pip uninstall ai-einblick-prompt
```
