rename

Author: Elijah Wilson

.github/assets/example.png

@@ -9,3 +9,5 @@ https://noteable.io/chatgpt-plugin-for-notebook/.
 
 This is heavily inspired by [dangermode](https://github.com/rgbkrk/dangermode).
 It could have been a fork, but the code is small enough that I started from scratch.
+
+![example](.github/assets/example.png)

README.md

@@ -1,14 +1,14 @@
 version: "3"
 
 vars:
-  LINT_DIRS: "notebookgpt/"
+  LINT_DIRS: "jupychat/"
 
 tasks:
   serve:
     deps:
       - install-deps
     cmds:
-      - poetry run uvicorn notebookgpt.main:app --reload --host "0.0.0.0" --port 8000
+      - poetry run uvicorn jupychat.main:app --reload --host "0.0.0.0" --port 8000
 
   install-deps:
     run: once

Taskfile.yaml

@@ -6,10 +6,10 @@
 from fastapi.middleware.cors import CORSMiddleware
 from fastapi.staticfiles import StaticFiles
 
-from notebookgpt.auth import jwks_client
-from notebookgpt.kernels import get_nb_gpt_kernel_client
-from notebookgpt.routes import api, auth, root
-from notebookgpt.settings import DOMAIN, get_settings
+from jupychat.auth import jwks_client
+from jupychat.kernels import get_nb_gpt_kernel_client
+from jupychat.routes import api, auth, root
+from jupychat.settings import DOMAIN, get_settings
 
 static_directory = pathlib.Path(__file__).parent / "static"
 

notebookgpt/app_utils.py renamed to jupychat/app_utils.py

@@ -4,7 +4,7 @@
 from jwt import PyJWKClient
 from starlette import status
 
-from notebookgpt.settings import get_settings
+from jupychat.settings import get_settings
 
 jwks_client = PyJWKClient(get_settings().jwks_url, cache_keys=True)
 bearer_scheme = HTTPBearer(auto_error=False)

notebookgpt/auth.py renamed to jupychat/auth.py

@@ -11,15 +11,15 @@
 from kernel_sidecar.models import messages
 from kernel_sidecar.models.messages import CellStatus, StreamChannel
 
-from notebookgpt.models import (
+from jupychat.models import (
     CreateKernelRequest,
     CreateKernelResponse,
     DisplayData,
     RunCellRequest,
     RunCellResponse,
     image_store,
 )
-from notebookgpt.settings import get_settings
+from jupychat.settings import get_settings
 
 logger = structlog.get_logger(__name__)
 
@@ -31,7 +31,7 @@ def safe_get_ipython():
     return InteractiveShellEmbed()
 
 
-class NotebookGPTKernelClient:
+class JupyChatKernelClient:
     """Client class for managing jupyter kernels.
 
     This wraps the jupyter multi kernel manager and provides a simple
@@ -52,7 +52,7 @@ async def start_kernel(self, request: CreateKernelRequest) -> CreateKernelRespon
 
     async def run_cell(self, request: RunCellRequest) -> RunCellResponse:
         sidecar_client = self._sidecar_clients[request.kernel_id]
-        output_handler = NotebookGPTOutputHandler(sidecar_client, uuid.uuid4().hex)
+        output_handler = JupyChatOutputHandler(sidecar_client, uuid.uuid4().hex)
         status_handler = StatusHandler()
         await sidecar_client.execute_request(
             request.code, handlers=[output_handler, status_handler]
@@ -66,7 +66,7 @@ async def shutdown_all(self) -> None:
             logger.info("Shut down kernel", kernel_id=kernel_id)
 
 
-class NotebookGPTOutputHandler(OutputHandler):
+class JupyChatOutputHandler(OutputHandler):
     def __init__(self, client: KernelSidecarClient, cell_id: str):
         super().__init__(client, cell_id)
 
@@ -125,7 +125,7 @@ async def handle_execute_reply(self, msg: messages.ExecuteReply) -> None:
 
 
 @lru_cache(maxsize=1)
-def get_nb_gpt_kernel_client() -> NotebookGPTKernelClient:
+def get_nb_gpt_kernel_client() -> JupyChatKernelClient:
     settings = get_settings()
     mkm = AsyncMultiKernelManager(connection_dir=settings.jupyter_connection_dir)
-    return NotebookGPTKernelClient(mkm)
+    return JupyChatKernelClient(mkm)

notebookgpt/kernels.py renamed to jupychat/kernels.py

@@ -0,0 +1,3 @@
+from jupychat.app_utils import build_app
+
+app = build_app()

jupychat/main.py

@@ -5,7 +5,7 @@
 from jupyter_client.kernelspec import NATIVE_KERNEL_NAME
 from pydantic import BaseModel, Field
 
-from notebookgpt.settings import DOMAIN
+from jupychat.settings import DOMAIN
 
 
 class RunCellRequest(BaseModel):

notebookgpt/models.py renamed to jupychat/models.py

@@ -1,22 +1,22 @@
 from fastapi import APIRouter, Depends, HTTPException, Security
 
-from notebookgpt.auth import verify_jwt
-from notebookgpt.kernels import NotebookGPTKernelClient, get_nb_gpt_kernel_client
-from notebookgpt.models import (
+from jupychat.auth import verify_jwt
+from jupychat.kernels import JupyChatKernelClient, get_nb_gpt_kernel_client
+from jupychat.models import (
     CreateKernelRequest,
     CreateKernelResponse,
     RunCellRequest,
     RunCellResponse,
 )
-from notebookgpt.suggestions import RUN_CELL_PARSE_FAIL
+from jupychat.suggestions import RUN_CELL_PARSE_FAIL
 
 router = APIRouter(dependencies=[Security(verify_jwt)])
 
 
 @router.post("/kernels")
 async def create_kernel(
     request: CreateKernelRequest,
-    kernel_client: NotebookGPTKernelClient = Depends(get_nb_gpt_kernel_client),
+    kernel_client: JupyChatKernelClient = Depends(get_nb_gpt_kernel_client),
 ) -> CreateKernelResponse:
     """Create and start kernel with the given kernel name."""
     return await kernel_client.start_kernel(request)
@@ -25,7 +25,7 @@ async def create_kernel(
 @router.post("/run-cell")
 async def run_cell(
     request: RunCellRequest,
-    kernel_client: NotebookGPTKernelClient = Depends(get_nb_gpt_kernel_client),
+    kernel_client: JupyChatKernelClient = Depends(get_nb_gpt_kernel_client),
 ) -> RunCellResponse:
     """Execute a cell and return the result.
 

notebookgpt/routes/api.py renamed to jupychat/routes/api.py

@@ -3,7 +3,7 @@
 import httpx
 from fastapi import APIRouter, Depends, HTTPException, Request, Response, status
 
-from notebookgpt.settings import Settings, get_settings
+from jupychat.settings import Settings, get_settings
 
 router = APIRouter()
 

notebookgpt/routes/auth.py renamed to jupychat/routes/auth.py

@@ -6,12 +6,12 @@
 from fastapi.templating import Jinja2Templates
 from jinja2 import Template
 
-from notebookgpt.auth import get_user_is_authenticated
-from notebookgpt.models import image_store
-from notebookgpt.settings import Settings, get_settings
+from jupychat.auth import get_user_is_authenticated
+from jupychat.models import image_store
+from jupychat.settings import Settings, get_settings
 
 router = APIRouter()
-templates = Jinja2Templates(directory="notebookgpt/templates")
+templates = Jinja2Templates(directory="jupychat/templates")
 
 
 @router.get("/.well-known/ai-plugin.json", include_in_schema=False)

notebookgpt/routes/root.py renamed to jupychat/routes/root.py

@@ -3,7 +3,7 @@
 
 from pydantic import BaseSettings
 
-DOMAIN = os.environ.get("NOTEBOOKGPT_DOMAIN", "http://localhost:8000")
+DOMAIN = os.environ.get("JUPYCHAT_DOMAIN", "http://localhost:8000")
 
 
 class Settings(BaseSettings):
@@ -17,9 +17,9 @@ class Settings(BaseSettings):
     jwks_url: str = "https://chatgpt-plugin-demo.us.auth0.com/.well-known/jwks.json"
     jwks_cache_time_sec: int = 300
 
-    oauth_audience: str = "https://example.com/notebookgpt"
+    oauth_audience: str = "https://example.com/jupychat"
 
-    jupyter_connection_dir: str = "/tmp/notebookgpt_connection_files"
+    jupyter_connection_dir: str = "/tmp/jupychat_connection_files"
 
 
 @lru_cache()

notebookgpt/settings.py renamed to jupychat/settings.py

@@ -1,9 +1,9 @@
 schema_version: v1
-name_for_human: NotebookGPT v2
-name_for_model: notebookgpt_v2
+name_for_human: JupyChat
+name_for_model: jupychat
 logo_url: {{ LOGO_URL }}
 contact_email: [email protected]
-legal_info_url: https://github.com/tizz98/notebookgpt/issues
+legal_info_url: https://github.com/tizz98/chatgpt-notebook-plugin/issues
 
 api:
     type: openapi

notebookgpt/static/images/logo.png renamed to jupychat/static/images/logo.png

@@ -1,5 +1,5 @@
 [tool.poetry]
-name = "notebookgpt"
+name = "jupychat"
 version = "0.1.0"
 description = "A simple ChatGPT plugin to run jupyter notebooks"
 authors = ["Elijah Wilson <[email protected]>"]