mito-ai 0.1.53__tar.gz → 0.1.55__tar.gz

mito_ai-0.1.55/PKG-INFO

@@ -0,0 +1,221 @@
+Metadata-Version: 2.4
+Name: mito_ai
+Version: 0.1.55
+Summary: AI chat for JupyterLab
+Project-URL: Homepage, https://trymito.io
+Project-URL: Bug Tracker, https://github.com/mito-ds/monorepo/issues
+Project-URL: Repository, https://github.com/mito-ds/monorepo
+Author-email: Aaron Diamond-Reivich <aaron@sagacollab.com>
+License: Copyright (c) 2020-2024 Saga Inc.
+        
+        See the LICENSE.txt file at the root of this monorepo for licensing information.
+License-File: LICENSE
+Keywords: jupyter,jupyterlab,jupyterlab-extension
+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.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.9
+Requires-Dist: analytics-python
+Requires-Dist: anthropic>=0.6.81
+Requires-Dist: google-genai
+Requires-Dist: jinja2>=3.0.3
+Requires-Dist: jupyterlab<5,>=4.1.0
+Requires-Dist: openai>=1.0.0
+Requires-Dist: pipreqs
+Requires-Dist: pydantic
+Requires-Dist: requests>=2.25.0
+Requires-Dist: sqlalchemy
+Requires-Dist: streamlit
+Requires-Dist: tornado>=6.2.0
+Requires-Dist: traitlets
+Requires-Dist: unidiff
+Provides-Extra: deploy
+Requires-Dist: hatch-jupyter-builder>=0.5; extra == 'deploy'
+Requires-Dist: hatch-nodejs-version>=0.3.2; extra == 'deploy'
+Requires-Dist: hatchling>=1.27.0; extra == 'deploy'
+Requires-Dist: twine>=4.0.0; extra == 'deploy'
+Provides-Extra: test
+Requires-Dist: mypy>=1.8.0; extra == 'test'
+Requires-Dist: pytest-asyncio==0.25.3; extra == 'test'
+Requires-Dist: pytest==8.3.4; extra == 'test'
+Requires-Dist: types-requests>=2.25.0; extra == 'test'
+Requires-Dist: types-setuptools; extra == 'test'
+Requires-Dist: types-tornado>=5.1.1; extra == 'test'
+Description-Content-Type: text/markdown
+
+# 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
+```
+
+## Configuration
+
+This extension has two AI providers; OpenAI and Mito (calling OpenAI).
+Mito is the fallback but the number of request is limited for free tier.
+To use OpenAI directly, you will to create an API key on https://platform.openai.com/docs/overview.
+Then set the environment variable `OPENAI_API_KEY` with that key.
+
+The OpenAI model can be configured with 1 parameters:
+- `OpenAIProvider.model`: Name of the AI model; default _gpt-4o-mini_.
+
+You can set those parameters through command line when starting JupyterLab; e.g.
+
+```sh
+jupyter lab --OpenAIProvider.max_completion_tokens 20 --OpenAIProvider.temperature 1.5
+```
+
+> If a value is incorrect, an error message will be displayed in the terminal logs.
+
+## 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]"
+
+# Install the node modules
+jlpm install
+
+# Build the extension
+jlpm build
+
+# 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
+
+# Watch the source directory in one terminal, automatically rebuilding when needed
+# 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 watch
+```
+
+Then, in a new terminal, run:
+
+```bash
+# Run JupyterLab in another terminal
+jupyter lab --autoreload
+```
+
+With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. With the `--autoreload` flag, you don't need to refresh JupyterLab to load the change in your browser. It will launch a new window each time you save a change to the backend.
+
+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
+
+#### Integration tests
+
+Integration tests for mito-ai are written using Playwright and Gelata in the mito/tests directory.
+
+To run these tests, follow the directions in the tests/README.md file.
+
+#### Backend Unit tests
+
+Backend tests for mito-ai are written using pytest in the mito/mito-ai/mito_ai/tests directory.
+
+To run the pytests, just run `pytest` in the mito-ai directory.
+
+#### Backend Mypy tests
+
+To run the mypy tests, just run `mypy mito_ai/ --ignore-missing-imports` in the mito-ai directory.
+
+#### Frontend Unit tests 
+
+Frontend unit tests for mito-ai are written using Jest in the mito/mito-ai/src/tests directory.
+
+To run the Jest tests, just run `npm test` in the mito-ai directory.
+
+#### Frontend Tests
+
+Frontend tests for mito-ai are written using Playwright and Gelata in the mito/tests directory. See the [tests/README.md](tests/README.md) file for more information.
+
+#### Frontend Linting
+
+Frontend linting for mito-ai is done using ESLint in the mito-ai directory.
+
+To run the ESLint tests, just run `jlpm eslint` in the mito-ai directory.
+
+#### Performance Tests
+
+Performance tests for mito-ai are written using pytest in the mito-ai/tests directory.
+
+To run the performance tests, just run `python -m pytest mito_ai/tests/performance_test.py -v -s` in the mito-ai directory.
+
+Note that you'll have to edit `open_ai_utils.py`, specifically the `is_running_test` condition.
+
+#### Running Databases
+
+To ensure reproducibility, databases, like Postgres, are created using Docker. To run:
+
+```bash
+docker-compose -f mito_ai/tests/docker/postgres.yml up
+```
+
+When you're done, stop and remove the container and its volumes with:
+
+```bash
+docker-compose -f mito_ai/tests/docker/postgres.yml down -v
+```

mito_ai-0.1.55/mito_ai/_version.py

@@ -0,0 +1,4 @@
+# This file is auto-generated by Hatchling. As such, do not:
+#   - modify
+#   - track in version control e.g. be sure to add to .gitignore
+__version__ = VERSION = '0.1.55'

mito_ai-0.1.55/mito_ai/completions/models.py

@@ -0,0 +1,404 @@
+# Copyright (c) Saga Inc.
+# Distributed under the terms of the GNU Affero General Public License v3.0 License.
+
+import traceback
+from dataclasses import dataclass, field
+from typing import List, Literal, Optional, NewType, Dict, Any
+from openai.types.chat import ChatCompletionMessageParam
+from enum import Enum
+from pydantic import BaseModel
+
+# The ThreadID is the unique identifier for the chat thread.
+ThreadID = NewType('ThreadID', str)
+  
+########################################################
+# Agent Response formats
+########################################################
+    
+class CellUpdate(BaseModel):
+    type: Literal['modification', 'new']
+    index: Optional[int]
+    id: Optional[str]
+    code: str
+    code_summary: str
+    cell_type: Optional[Literal['code', 'markdown']]
+
+
+# Using a discriminated Pydantic model doesn't work well with OpenAI's API, 
+# so instead we just combine all of the possible response types into a single class 
+# for now and rely on the AI to respond with the correct types, following the format
+# that we show it in the system prompt.
+class AgentResponse(BaseModel):
+    type: Literal['cell_update', 'get_cell_output', 'run_all_cells', 'finished_task', 'create_streamlit_app', 'edit_streamlit_app']
+    message: str
+    cell_update: Optional[CellUpdate]
+    get_cell_output_cell_id: Optional[str]
+    next_steps: Optional[List[str]]
+    analysis_assumptions: Optional[List[str]]
+    streamlit_app_prompt: Optional[str]
+    
+    
+@dataclass(frozen=True)
+class ResponseFormatInfo():
+    name: str
+    # Use the type because we are actually just providing the type format, not an actual instance of the format
+    format: type[AgentResponse]
+
+########################################################
+# Message Types and Metadata
+########################################################
+
+class MessageType(Enum):
+    """
+    This is all of the different types of messages that we support through the on_message handler.
+    """
+    CHAT = "chat"
+    SMART_DEBUG = "smartDebug"
+    CODE_EXPLAIN = "codeExplain"
+    AGENT_EXECUTION = "agent:execution"
+    AGENT_AUTO_ERROR_FIXUP = "agent:autoErrorFixup"
+    INLINE_COMPLETION = "inline_completion"
+    CHAT_NAME_GENERATION = "chat_name_generation"
+    START_NEW_CHAT = "start_new_chat"
+    FETCH_HISTORY = "fetch_history"
+    GET_THREADS = "get_threads"
+    DELETE_THREAD = "delete_thread"
+    UPDATE_MODEL_CONFIG = "update_model_config"
+    STREAMLIT_CONVERSION = "streamlit_conversion"
+    STOP_AGENT = "stop_agent"
+    DEPLOY_APP = "deploy_app"
+
+    
+@dataclass(frozen=True)
+class AIOptimizedCell():
+  cell_type: str
+  id: str
+  code: str
+  
+
+@dataclass(frozen=True)
+class ChatMessageMetadata():
+    promptType: Literal['chat']
+    threadId: ThreadID
+    input: str
+    activeCellCode: str 
+    activeCellId: str
+    variables: Optional[List[str]] = None
+    files: Optional[List[str]] = None
+    base64EncodedActiveCellOutput: Optional[str] = None
+    index: Optional[int] = None
+    stream: bool = False
+    additionalContext: Optional[List[Dict[str, str]]] = None
+    
+    
+@dataclass(frozen=True)
+class AgentExecutionMetadata():
+    promptType: Literal['agent:execution']
+    threadId: ThreadID
+    input: str
+    aiOptimizedCells: List[AIOptimizedCell]
+    activeCellId: str
+    isChromeBrowser: bool
+    notebookPath: str
+    notebookID: str
+    base64EncodedActiveCellOutput: Optional[str] = None
+    variables: Optional[List[str]] = None
+    files: Optional[List[str]] = None
+    index: Optional[int] = None
+    additionalContext: Optional[List[Dict[str, str]]] = None
+    
+@dataclass(frozen=True)
+class AgentSmartDebugMetadata():
+    promptType: Literal['agent:autoErrorFixup']
+    threadId: ThreadID
+    aiOptimizedCells: List[AIOptimizedCell]
+    errorMessage: str
+    error_message_producing_code_cell_id: str
+    isChromeBrowser: bool
+    variables: Optional[List[str]] = None
+    files: Optional[List[str]] = None
+    
+@dataclass(frozen=True)
+class SmartDebugMetadata():
+    promptType: Literal['smartDebug']
+    threadId: ThreadID
+    errorMessage: str
+    activeCellCode: str 
+    activeCellId: str
+    variables: Optional[List[str]] = None
+    files: Optional[List[str]] = None
+    
+@dataclass(frozen=True)
+class CodeExplainMetadata():    
+    promptType: Literal['codeExplain']
+    threadId: ThreadID
+    variables: Optional[List[str]] = None
+    activeCellCode: Optional[str] = None
+    
+@dataclass(frozen=True)
+class InlineCompleterMetadata():
+    promptType: Literal['inline_completion']
+    prefix: str 
+    suffix: str
+    variables: Optional[List[str]] = None
+    files: Optional[List[str]] = None
+
+@dataclass(frozen=True)
+class CompletionRequest:
+    """
+    Message send by the client to request an AI chat response.
+    """
+
+    # Message type.
+    type: MessageType
+
+    # Message UID generated by the client.
+    message_id: str
+
+    # Chat messages.
+    messages: List[ChatCompletionMessageParam] = field(default_factory=list)
+
+    # Whether to stream the response (if supported by the model).
+    stream: bool = False
+    
+    # Environment information from the client
+    environment: Optional[Dict[str, Any]] = None
+    
+    
+@dataclass(frozen=True)
+class AICapabilities:
+    """
+    AI provider capabilities
+    """
+
+    # Configuration schema.
+    configuration: dict
+
+    # AI provider name.
+    provider: str
+
+    # Message type.
+    type: str = "ai_capabilities"
+
+
+@dataclass(frozen=True)
+class CompletionItemError:
+    """
+    Completion item error information.
+    """
+
+    # Error message.
+    message: Optional[str] = None
+
+
+@dataclass(frozen=True)
+class CompletionItem:
+    """
+    A completion suggestion.
+    """
+
+    # The completion.
+    content: str
+
+    # Whether the completion is incomplete or not.
+    isIncomplete: Optional[bool] = None
+    
+    # Unique token identifying the completion request in the frontend.
+    token: Optional[str] = None
+
+    # Error information for the completion item.
+    error: Optional[CompletionItemError] = None
+
+
+@dataclass(frozen=True)
+class CompletionError:
+    """
+    Completion error description.
+    """
+
+    # Error type.
+    error_type: str
+
+    # Error title.
+    title: str
+
+    # Error traceback.
+    traceback: str
+
+    # Hint to resolve the error.
+    hint: str = ""
+
+    @staticmethod
+    def from_exception(exception: BaseException, hint: str = "") -> "CompletionError":
+        """
+        Create a completion error from an exception.
+        
+        Note: OpenAI exceptions can include a 'body' attribute with detailed error information.
+        While mypy doesn't know about this attribute on BaseException, we need to handle it
+        to properly extract error messages from OpenAI API responses.
+        """
+        from mito_ai.utils.mito_server_utils import ProviderCompletionException
+
+        
+        # Handle ProviderCompletionException specially
+        if isinstance(exception, ProviderCompletionException):
+            return CompletionError(
+                error_type="LLM Provider Error", 
+                title=exception.user_friendly_title, 
+                traceback=traceback.format_exc(),
+                hint=exception.user_friendly_hint
+            )
+        
+        # Handle all other exceptions as before
+        error_type = type(exception)
+        error_module = getattr(error_type, "__module__", "")
+        
+        # Handle OpenAI exceptions that have a 'body' attribute
+        title = ""
+        body = getattr(exception, "body", None)
+        if body and hasattr(body, "get"):
+            title = body.get("message", "")
+        
+        if not title and exception.args:
+            title = exception.args[0]
+        
+        if not title:
+            title = "Exception"
+            
+        return CompletionError(
+            error_type=f"{error_module}.{error_type.__name__}"
+            if error_module
+            else error_type.__name__,
+            title=title,
+            traceback=traceback.format_exc(),
+            hint=hint,
+        )
+
+@dataclass(frozen=True)
+class ErrorMessage(CompletionError):
+    """
+    Error message.
+    """
+
+    # Message type.
+    type: Literal["error"] = "error"
+
+
+
+@dataclass(frozen=True)
+class CompletionReply:
+    """
+    Message sent from model to client with the completion suggestions.
+    """
+
+    # List of completion items.
+    items: List[CompletionItem]
+
+    # Parent message UID.
+    parent_id: str
+
+    # Message type.
+    type: Literal["reply"] = "reply"
+
+    # Completion error.
+    error: Optional[CompletionError] = None
+
+
+@dataclass(frozen=True)
+class CompletionStreamChunk:
+    """
+    Message sent from model to client with the infill suggestions
+    """
+
+    chunk: CompletionItem
+
+    # Parent message UID.
+    parent_id: str
+
+    # Whether the completion is done or not.
+    done: bool
+
+    # Message type.
+    type: Literal["chunk"] = "chunk"
+
+    # Completion error.
+    error: Optional[CompletionError] = None
+    """Completion error."""
+
+@dataclass(frozen=True)
+class FetchHistoryReply:
+    """
+    Message sent from model to client with the chat history.
+    """
+
+    # Message UID.
+    parent_id: str
+
+    # List of chat messages.
+    items: List[ChatCompletionMessageParam]
+
+    # Message type.
+    type: Literal["reply"] = "reply"
+
+@dataclass(frozen=True)
+class ChatThreadMetadata:
+    """
+    Chat thread item.
+    """
+
+    thread_id: ThreadID
+
+    name: str
+
+    creation_ts: float
+
+    last_interaction_ts: float
+
+@dataclass(frozen=True)
+class StartNewChatReply:
+    """
+    Message sent from model to client after starting a new chat thread.
+    """
+
+    # Message UID.
+    parent_id: str
+
+    # Chat thread item.
+    thread_id: ThreadID
+
+    # Message type.
+    type: Literal["reply"] = "reply"
+
+@dataclass(frozen=True)
+class FetchThreadsReply:
+    """
+    Message sent from model to client with the chat threads.
+    """
+
+    # Message UID.
+    parent_id: str
+
+    # List of chat threads.
+    threads: List[ChatThreadMetadata]
+
+    # Message type.
+    type: Literal["reply"] = "reply"
+
+@dataclass(frozen=True)
+class DeleteThreadReply:
+    """
+    Message sent from model to client after deleting a chat thread.
+    """
+
+    # Message UID.
+    parent_id: str
+
+    #Success message
+    success: bool
+
+    # Message type.
+    type: Literal["reply"] = "reply"
+
+@dataclass(frozen=True)
+class UpdateModelConfigMetadata:
+    model: str