Metadata-Version: 2.1
Name: chapyter
Version: 0.2.0
Summary: A Natural Language-Based Python Program Interpreter
Project-URL: Homepage, https://github.com/chapyter/chapyter
Project-URL: Bug Tracker, https://github.com/chapyter/chapyter/issues
Project-URL: Repository, https://github.com/chapyter/chapyter.git
Author-email: chapyter <zejiangshen@gmail.com>
License: BSD 3-Clause License
        
        Copyright (c) 2023, chapyter
        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
Requires-Dist: guidance
Requires-Dist: jupyterlab>=4.0
Requires-Dist: python-dotenv
Description-Content-Type: text/markdown

<div align="center">
  <img src="https://github.com/chapyter/chapyter/raw/main/.github/chapyter-logo.png" alt="Chapyter Logo" width="35%">
  <h3 align="center">
  Chapyter is a jupyterlab extension for NL"P": Natural Language-based Programming
  </h3>
</div>

## Demo 
<div align="center">
<img src="https://github.com/chapyter/chapyter/raw/main/.github/chapyter-starter.png" alt="Chapyter Starter Demo" width="75%">
</div>

## Quick Start
 
1. Installation 
    ```bash
    pip install chapyter   # Automatically installs the extension to jupyterlab
    pip uninstall chapyter # Uninstalls the extension from jupyterlab
    ```
    Note: It will upgrade the jupyterlab to ≥ 4.0. It might break your environments. 

2. Usage: see [examples/starter.ipynb](examples/starter.ipynb) for a starter notebook. 

    1. Set the proper `OPENAI_API_KEY` and `OPENAI_ORGANIZATION` in the environment variable 
    2. Use the magic command `%%chat` in a code cell: 
        ```
        %%chat -m gpt-4-0613 
        List all the files in the folder 
        ```
       It will call gpt-4-0613 to generate the python code for listing all the files in the folder, and 
       execute the generated code automatically. **In this case, this plugin serves as the interpreter that**
       **translates the natural language to python code and execute it.** 

3. Examples: 
    - [examples/starter.ipynb](examples/starter.ipynb) A starter notebook illustrating the basic functions of `chapyter`. 
    
## Development Notes

1. NodeJS is needed to build the extension package.

2. The `jlpm` command is JupyterLab's pinned version of [yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
`yarn` or `npm` in lieu of `jlpm` below.
    ```bash
    # Clone the repo to your local environment
    # Change directory to the chapyter directory
    # Install package in development mode
    pip install -e "."
    # Link your development version of the extension with JupyterLab
    jupyter labextension develop . --overwrite
    # Rebuild extension Typescript source after making changes
    jlpm build
    ```

3. You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
    ```bash
    # Watch the source directory in one terminal, automatically rebuilding when needed
    jlpm watch
    # Run JupyterLab in another terminal
    jupyter lab
    ```
    With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).

4. By default, the `jlpm build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:
    ```bash
    jupyter lab build --minimize=False
    ```

5. Packaging and release: please refer to [RELEASE](RELEASE.md). 