Metadata-Version: 2.1
Name: mito-ai
Version: 0.1.2
Summary: AI chat for JupyterLab
Home-page: UNKNOWN
Author: Aaron Diamond-Reivich
Author-email: aaron@sagacollab.com
License: GNU Affero General Public License v3
Description: # mito_ai
        
        [![Github Actions Status](/workflows/Build/badge.svg)](/actions/workflows/build.yml)
        
        AI chat for JupyterLab. This codebase contains two main components:
        1. A Jupyter server extension that handles the backend logic for the chat.
        2. Several JupyterLab extensions that handle the frontend logic for interacting with the AI, including the chat sidebar and the error message rendermime.
        
        ## Requirements
        
        - JupyterLab >= 4.0.0
        
        ## Install
        
        To install the extension, execute:
        
        ```bash
        pip install mito-ai
        ```
        
        ## Uninstall
        
        To remove the extension, execute:
        
        ```bash
        pip uninstall mito-ai
        ```
        
        ## Contributing
        
        ### Development install
        
        To ensure consistent package management, please use `jlpm` instead of `npm` for this project.
        
        Note: You will need NodeJS to build the extension package.
        
        The `jlpm` command is JupyterLab's pinned version of
        [yarn](https://yarnpkg.com/) that is installed with JupyterLab. 
        
        ```bash
        # Clone the repo to your local environment
        # Change directory to the mito-ai directory
        
        # Required to deal with Yarn 3 workspace rules
        touch yarn.lock
        
        # Install package in development mode
        pip install -e ".[test, deploy]"
        
        # Install the node modules
        jlpm install
        
        # Link your development version of the extension with JupyterLab
        jupyter labextension develop . --overwrite
        
        # Start the jupyter server extension for development
        jupyter server extension enable --py mito-ai
        
        # Rebuild extension Typescript source after making changes
        # In case of Error: If this command fails because the lib directory was not created (the error will say something like
        # unable to find main entry point) then run `jlpm run clean:lib` first to get rid of the old buildcache 
        # that might be preventing a new lib directory from getting created. 
        jlpm build
        ```
        
        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).
        
        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
        ```
        
        ### Development uninstall
        
        ```bash
        pip uninstall mito-ai
        ```
        
        In development mode, you will also need to remove the symlink created by `jupyter labextension develop`
        command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`
        folder is located. Then you can remove the symlink named `mito-ai` within that folder.
        
        ### Testing the extension
        
        #### Frontend tests
        
        This extension is using [Jest](https://jestjs.io/) for JavaScript code testing.
        
        To execute them, execute:
        
        ```sh
        jlpm
        jlpm test
        ```
        
        #### Integration tests
        
        This extension uses [Playwright](https://playwright.dev/docs/intro) for the integration tests (aka user level tests).
        More precisely, the JupyterLab helper [Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to handle testing the extension in JupyterLab.
        
        More information are provided within the [ui-tests](./ui-tests/README.md) README.
        
        ### Packaging the extension
        
        See [RELEASE](RELEASE.md)
        
Keywords: AI,Jupyter,Mito
Platform: UNKNOWN
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
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Provides-Extra: deploy
