getting started stuff

Author: Elijah Wilson

.env.example

@@ -0,0 +1,4 @@
+auth0_domain=https://chatgpt-plugin-demo.us.auth0.com
+jwks_url=https://chatgpt-plugin-demo.us.auth0.com/.well-known/jwks.json
+domain=https://ff72e324bef5.ngrok.app
+openai_verification_token=unset

README.md

@@ -11,3 +11,39 @@ 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)
+
+## Get Started
+
+### Pre-requisites
+
+1. Auth0 Account Created
+2. Auth0 Application Created
+3. Auth0 API Created (use `https://example.com/jupychat` as the identifier and audience)
+4. Python 3.11+ installed
+5. [Poetry](https://python-poetry.org/) installed
+6. [Task](https://taskfile.dev/) installed
+
+### Run the FastAPI server
+
+1. Clone this repository
+2. `cp .env.example .env`
+3. Fill out your auth0 details in `.env`
+4. `task serve`
+
+### Configure the plugin
+
+1. To use OAuth, you can't use localhost for the plugin. I recommend using [ngrok](https://ngrok.com).
+2. `ngrok http 8000`
+3. Copy the ngrok URL and add it to your `.env` as `domain=...`
+4. Restart your FastAPI server
+5. Copy the ngrok URL and paste it into the ChatGPT plugin UI
+6. Copy and paste your Auth0 Application's Client ID and Client Secret into the ChatGPT plugin UI
+7. Copy the verification token from the ChatGPT plugin UI and paste it into your `.env` like `openai_verification_token=...`
+8. Restart your FastAPI server
+
+### Notes / Caveats
+
+1. Every time you change your `ai-plugin.json`, you need to recreate your plugin in ChatGPT
+   1. This means you'll get a new verification token too. You'll need to update your `.env` and restart your FastAPI server
+2. All kernel state is lost when your FastAPI server restarts. This is sort of a bug, it could be fixed by connecting to any kernels already running in the connections directory.
+3. The code getting generated by ChatGPT is mostly lost. It's only saved in the ChatGPT UI. [Noteable's plugin](https://noteable.io/chatgpt-plugin-for-notebook/) writes changes back to your file and you can view it execute in real time.

jupychat/app_utils.py

@@ -9,7 +9,7 @@
 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
+from jupychat.settings import get_settings
 
 static_directory = pathlib.Path(__file__).parent / "static"
 
@@ -29,10 +29,12 @@ async def lifespan(app: FastAPI):
 
 
 def build_app():
+    settings = get_settings()
+
     app = FastAPI(
         lifespan=lifespan,
         openapi_url="/openapi.json",
-        servers=[{"url": DOMAIN, "description": "Notebook GPT server"}],
+        servers=[{"url": settings.domain, "description": "Notebook GPT server"}],
     )
 
     app.add_middleware(

jupychat/models.py

@@ -5,7 +5,7 @@
 from jupyter_client.kernelspec import NATIVE_KERNEL_NAME
 from pydantic import BaseModel, Field
 
-from jupychat.settings import DOMAIN
+from jupychat.settings import get_settings
 
 
 class RunCellRequest(BaseModel):
@@ -49,7 +49,7 @@ def store_images(self, dd: DisplayData) -> DisplayData:
             image_data = base64.b64decode(dd.data["image/png"])
 
             self.image_store[image_name] = ImageData(
-                data=image_data, url=f"{DOMAIN}/images/{image_name}"
+                data=image_data, url=f"{get_settings().domain}/images/{image_name}"
             )
             dd.data["image/png"] = self.image_store[image_name].url
 

jupychat/settings.py

@@ -1,26 +1,40 @@
-import os
 from functools import lru_cache
 
 from pydantic import BaseSettings
 
-DOMAIN = os.environ.get("JUPYCHAT_DOMAIN", "http://localhost:8000")
-
 
 class Settings(BaseSettings):
-    logo_url: str = f"{DOMAIN}/static/images/logo.png"
-    openapi_url: str = f"{DOMAIN}/openapi.json"
-    oauth_client_url: str = f"{DOMAIN}/oauth/authorize"
-    oauth_authorization_url: str = f"{DOMAIN}/oauth/token"
+    domain: str = "http://localhost:8000"
+
+    @property
+    def logo_url(self):
+        return f"{self.domain}/static/images/logo.png"
+
+    @property
+    def openapi_url(self):
+        return f"{self.domain}/openapi.json"
+
+    @property
+    def oauth_client_url(self):
+        return f"{self.domain}/oauth/authorize"
+
+    @property
+    def oauth_authorization_url(self):
+        return f"{self.domain}/oauth/token"
+
     openai_verification_token: str = "unset"
 
-    auth0_domain: str = "https://chatgpt-plugin-demo.us.auth0.com"
-    jwks_url: str = "https://chatgpt-plugin-demo.us.auth0.com/.well-known/jwks.json"
+    auth0_domain: str
+    jwks_url: str
     jwks_cache_time_sec: int = 300
 
     oauth_audience: str = "https://example.com/jupychat"
 
     jupyter_connection_dir: str = "/tmp/jupychat_connection_files"
 
+    class Config:
+        env_file = ".env"
+
 
 @lru_cache()
 def get_settings():

poetry.lock

@@ -21,6 +21,7 @@ ipython = "^8.13.2"
 kernel-sidecar = "^0.5.5"
 cryptography = "^40.0.2"
 ipykernel = "^6.23.1"
+pydantic = {extras = ["dotenv"], version = "^1.10.8"}
 
 
 [tool.poetry.group.dev.dependencies]