Merge pull request #70 from daily-co/move-src-example-to-examples

move src/examples to examples

README.md

@@ -46,7 +46,7 @@ Currently implemented services:
 
 If you'd like to [implement a service]((https://github.com/daily-co/daily-ai-sdk/tree/main/src/dailyai/services)), we welcome PRs! Our goal is to support lots of services in all of the above categories, plus new categories (like real-time video) as they emerge.
 
-## Step 1: Get started
+## Getting started
 
 Today, the easiest way to get started with `dailyai` is to use [Daily](https://www.daily.co/) as your transport service. This toolkit started life as an internal SDK at Daily and millions of minutes of AI conversation have been served using it and its earlier prototype incarnations. (The [transport base class](https://github.com/daily-co/daily-ai-sdk/blob/main/src/dailyai/services/base_transport_service.py) is easy to extend, though, so feel free to submit PRs if you'd like to implement another transport service.)
 
@@ -56,21 +56,20 @@ pip install dailyai
 
 # set up an .env file with API keys
 cp dot-env.template .env
-
-# sign up for a free Daily account, if you don't already have one, and
-# join the Daily room URL directly from a browser tab, then run one of the
-# samples
-python src/examples/foundational/02-llm-say-one-thing.py
 ```
 
 ## Code examples
 
 There are two directories of examples:
 
-- [foundational](https://github.com/daily-co/daily-ai-sdk/tree/main/src/examples/foundational) — demos that build on each other, introducing one or two concepts at a time
-- [starter apps](https://github.com/daily-co/daily-ai-sdk/tree/main/src/examples/starter-apps) — complete applications that you can use as starting points for development
+- [foundational](https://github.com/daily-co/daily-ai-sdk/tree/main/examples/foundational) — demos that build on each other, introducing one or two concepts at a time
+- [starter apps](https://github.com/daily-co/daily-ai-sdk/tree/main/examples/starter-apps) — complete applications that you can use as starting points for development
 
+To run the example below you to sign up for a [free Daily account](https://dashboard.daily.co/u/signup) (so you can hear the LLM talking) and create a Daily room. After that, join the room's URL directly from a browser tab and run:
 
+```
+python examples/foundational/02-llm-say-one-thing.py
+```
 
 ## Hacking on the framework itself
 

docs/README.md

@@ -6,7 +6,7 @@ Learn about the thinking behind the SDK's design.
 
 ## [Example Code](examples/)
 
-The repo includes several example apps in the `src/examples` directory. The docs explain how they work.
+The repo includes several example apps in the `examples` directory. The docs explain how they work.
 
 ## [API Reference](api/)
 

docs/examples/01-say-one-thing.md

@@ -16,7 +16,7 @@ if __name__ == "__main__":
 
 ### `configure()`
 
-The `configure()` function comes from `src/examples/foundational/support/runner.py`, and it allows you to configure the examples from the command line directly, or using environment variables:
+The `configure()` function comes from `examples/foundational/support/runner.py`, and it allows you to configure the examples from the command line directly, or using environment variables:
 
 ```bash
 python 01-say-one-thing.py -u https://YOUR_DOMAIN.daily.co/YOUR_ROOM -k YOUR_API_KEY

docs/examples/README.md

@@ -1,5 +1,5 @@
 # Daily AI SDK Examples
 
-The docs in this folder pair with the example apps located in `src/examples/foundational`. They are designed to serve as a quick references for building different kinds of AI apps. But the examples also build on one another, so it can be really helpful to walk through them in order.
+The docs in this folder pair with the example apps located in `examples/foundational`. They are designed to serve as a quick references for building different kinds of AI apps. But the examples also build on one another, so it can be really helpful to walk through them in order.
 
 To start, you can learn about the overall structure of the examples in [01 - Say One Thing](01-say-one-thing.md).

src/examples/foundational/01-say-one-thing.py → examples/foundational/01-say-one-thing.py

@@ -8,7 +8,10 @@
 from dailyai.services.daily_transport_service import DailyTransportService
 from dailyai.services.elevenlabs_ai_service import ElevenLabsTTSService
 
-from examples.support.runner import configure
+from runner import configure
+
+from dotenv import load_dotenv
+load_dotenv()
 
 logging.basicConfig(format=f"%(levelno)s %(asctime)s %(message)s")
 logger = logging.getLogger("dailyai")

src/examples/foundational/02-llm-say-one-thing.py → examples/foundational/02-llm-say-one-thing.py

@@ -10,7 +10,10 @@
 from dailyai.services.elevenlabs_ai_service import ElevenLabsTTSService
 from dailyai.services.open_ai_services import OpenAILLMService
 
-from examples.support.runner import configure
+from runner import configure
+
+from dotenv import load_dotenv
+load_dotenv()
 
 logging.basicConfig(format=f"%(levelno)s %(asctime)s %(message)s")
 logger = logging.getLogger("dailyai")

src/examples/foundational/03-still-frame.py → examples/foundational/03-still-frame.py

@@ -8,7 +8,10 @@
 from dailyai.services.daily_transport_service import DailyTransportService
 from dailyai.services.fal_ai_services import FalImageGenService
 
-from examples.support.runner import configure
+from runner import configure
+
+from dotenv import load_dotenv
+load_dotenv()
 
 logging.basicConfig(format=f"%(levelno)s %(asctime)s %(message)s")
 logger = logging.getLogger("dailyai")

src/examples/foundational/04-utterance-and-speech.py → examples/foundational/04-utterance-and-speech.py

@@ -11,7 +11,11 @@
 from dailyai.services.deepgram_ai_services import DeepgramTTSService
 from dailyai.pipeline.frames import EndFrame, EndPipeFrame, LLMMessagesQueueFrame, TextFrame
 from dailyai.services.elevenlabs_ai_service import ElevenLabsTTSService
-from examples.support.runner import configure
+
+from runner import configure
+
+from dotenv import load_dotenv
+load_dotenv()
 
 logging.basicConfig(format=f"%(levelno)s %(asctime)s %(message)s")
 logger = logging.getLogger("dailyai")

src/examples/foundational/05-sync-speech-and-image.py → examples/foundational/05-sync-speech-and-image.py

@@ -29,7 +29,10 @@
 from dailyai.services.elevenlabs_ai_service import ElevenLabsTTSService
 from dailyai.services.fal_ai_services import FalImageGenService
 
-from examples.support.runner import configure
+from runner import configure
+
+from dotenv import load_dotenv
+load_dotenv()
 
 logging.basicConfig(format=f"%(levelno)s %(asctime)s %(message)s")
 logger = logging.getLogger("dailyai")

src/examples/foundational/06-listen-and-respond.py → examples/foundational/06-listen-and-respond.py

@@ -13,7 +13,10 @@
     LLMAssistantContextAggregator,
     LLMUserContextAggregator,
 )
-from examples.support.runner import configure
+from runner import configure
+
+from dotenv import load_dotenv
+load_dotenv()
 
 logging.basicConfig(format=f"%(levelno)s %(asctime)s %(message)s")
 logger = logging.getLogger("dailyai")

src/examples/foundational/06a-image-sync.py → examples/foundational/06a-image-sync.py

@@ -19,7 +19,11 @@
 from dailyai.services.open_ai_services import OpenAILLMService
 from dailyai.services.elevenlabs_ai_service import ElevenLabsTTSService
 from dailyai.services.fal_ai_services import FalImageGenService
-from examples.support.runner import configure
+
+from runner import configure
+
+from dotenv import load_dotenv
+load_dotenv()
 
 logging.basicConfig(format=f"%(levelno)s %(asctime)s %(message)s")
 logger = logging.getLogger("dailyai")

src/examples/foundational/07-interruptible.py → examples/foundational/07-interruptible.py

@@ -14,7 +14,11 @@
 from dailyai.services.daily_transport_service import DailyTransportService
 from dailyai.services.open_ai_services import OpenAILLMService
 from dailyai.services.elevenlabs_ai_service import ElevenLabsTTSService
-from examples.support.runner import configure
+
+from runner import configure
+
+from dotenv import load_dotenv
+load_dotenv()
 
 logging.basicConfig(format=f"%(levelno)s %(asctime)s %(message)s")
 logger = logging.getLogger("dailyai")

src/examples/foundational/08-bots-arguing.py → examples/foundational/08-bots-arguing.py

@@ -11,7 +11,11 @@
 from dailyai.services.elevenlabs_ai_service import ElevenLabsTTSService
 from dailyai.services.fal_ai_services import FalImageGenService
 from dailyai.pipeline.frames import AudioFrame, EndFrame, ImageFrame, LLMMessagesQueueFrame, TextFrame
-from examples.support.runner import configure
+
+from runner import configure
+
+from dotenv import load_dotenv
+load_dotenv()
 
 logging.basicConfig(format=f"%(levelno)s %(asctime)s %(message)s")
 logger = logging.getLogger("dailyai")

src/examples/foundational/10-wake-word.py → examples/foundational/10-wake-word.py

@@ -21,7 +21,11 @@
     TranscriptionQueueFrame,
 )
 from dailyai.services.ai_services import AIService
-from examples.support.runner import configure
+
+from runner import configure
+
+from dotenv import load_dotenv
+load_dotenv()
 
 logging.basicConfig(format=f"%(levelno)s %(asctime)s %(message)s")
 logger = logging.getLogger("dailyai")

src/examples/foundational/11-sound-effects.py → examples/foundational/11-sound-effects.py

@@ -21,7 +21,10 @@
 )
 from typing import AsyncGenerator
 
-from examples.support.runner import configure
+from runner import configure
+
+from dotenv import load_dotenv
+load_dotenv()
 
 logging.basicConfig(format=f"%(levelno)s %(asctime)s %(message)s")
 logger = logging.getLogger("dailyai")

src/examples/foundational/13-whisper-transcription.py → examples/foundational/13-whisper-transcription.py

@@ -3,7 +3,11 @@
 
 from dailyai.services.daily_transport_service import DailyTransportService
 from dailyai.services.whisper_ai_services import WhisperSTTService
-from examples.support.runner import configure
+
+from runner import configure
+
+from dotenv import load_dotenv
+load_dotenv()
 
 logging.basicConfig(format=f"%(levelno)s %(asctime)s %(message)s")
 logger = logging.getLogger("dailyai")

src/examples/support/runner.py → examples/foundational/runner.py

@@ -4,9 +4,6 @@
 import urllib
 import requests
 
-from dotenv import load_dotenv
-load_dotenv()
-
 
 def configure():
     parser = argparse.ArgumentParser(description="Daily AI SDK Bot Sample")

src/examples/internal/11a-dial-out.py → examples/internal/11a-dial-out.py

@@ -10,7 +10,10 @@
 from dailyai.pipeline.frames import Frame, AudioFrame, LLMResponseEndFrame, LLMMessagesQueueFrame
 from typing import AsyncGenerator
 
-from examples.support.runner import configure
+from runner import configure
+
+from dotenv import load_dotenv
+load_dotenv()
 
 sounds = {}
 sound_files = [

src/examples/server/auth.py → examples/server/auth.py

@@ -1,13 +1,10 @@
 import time
 import urllib
 
-from dotenv import load_dotenv
 import requests
 from flask import jsonify
 import os
 
-load_dotenv()
-
 
 def get_meeting_token(room_name, daily_api_key, token_expiry):
     api_path = os.getenv('DAILY_API_PATH') or 'https://api.daily.co/v1'

src/examples/server/daily-bot-manager.py → examples/server/daily-bot-manager.py

@@ -5,10 +5,10 @@
 
 from flask import Flask, jsonify, request, redirect
 from flask_cors import CORS
-from examples.server.auth import get_meeting_token
 
-from dotenv import load_dotenv
+from auth import get_meeting_token
 
+from dotenv import load_dotenv
 load_dotenv()
 
 app = Flask(__name__)
@@ -95,7 +95,7 @@ def start_bot(bot_path, args=None):
 
 @app.route("/spin-up-kitty", methods=["GET", "POST"])
 def spin_up_kitty():
-    return start_bot("./src/examples/foundational/10-wake-word.py")
+    return start_bot("./examples/foundational/10-wake-word.py")
 
 
 @app.route("/healthz")

src/examples/starter-apps/chatbot.py → examples/starter-apps/chatbot.py

@@ -23,7 +23,11 @@
 from dailyai.services.daily_transport_service import DailyTransportService
 from dailyai.services.open_ai_services import OpenAILLMService
 from dailyai.services.elevenlabs_ai_service import ElevenLabsTTSService
-from examples.support.runner import configure
+
+from runner import configure
+
+from dotenv import load_dotenv
+load_dotenv()
 
 logging.basicConfig(format=f"%(levelno)s %(asctime)s %(message)s")
 logger = logging.getLogger("dailyai")

src/examples/starter-apps/patient-intake.py → examples/starter-apps/patient-intake.py

@@ -20,7 +20,6 @@
 from dailyai.services.open_ai_services import OpenAILLMService
 from dailyai.services.deepgram_ai_services import DeepgramTTSService
 from dailyai.services.elevenlabs_ai_service import ElevenLabsTTSService
-from examples.support.runner import configure
 from dailyai.pipeline.frames import (
     OpenAILLMContextFrame,
     TranscriptionQueueFrame,
@@ -36,6 +35,11 @@
     ChatCompletionToolParam,
 )
 
+from runner import configure
+
+from dotenv import load_dotenv
+load_dotenv()
+
 logging.basicConfig(format="%(levelno)s %(asctime)s %(message)s")
 logger = logging.getLogger("dailyai")
 logger.setLevel(logging.DEBUG)

examples/starter-apps/runner.py

@@ -0,0 +1,58 @@
+import argparse
+import os
+import time
+import urllib
+import requests
+
+
+def configure():
+    parser = argparse.ArgumentParser(description="Daily AI SDK Bot Sample")
+    parser.add_argument(
+        "-u",
+        "--url",
+        type=str,
+        required=False,
+        help="URL of the Daily room to join")
+    parser.add_argument(
+        "-k",
+        "--apikey",
+        type=str,
+        required=False,
+        help="Daily API Key (needed to create an owner token for the room)",
+    )
+
+    args, unknown = parser.parse_known_args()
+
+    url = args.url or os.getenv("DAILY_SAMPLE_ROOM_URL")
+    key = args.apikey or os.getenv("DAILY_API_KEY")
+
+    if not url:
+        raise Exception(
+            "No Daily room specified. use the -u/--url option from the command line, or set DAILY_SAMPLE_ROOM_URL in your environment to specify a Daily room URL.")
+
+    if not key:
+        raise Exception("No Daily API key specified. use the -k/--apikey option from the command line, or set DAILY_API_KEY in your environment to specify a Daily API key, available from https://dashboard.daily.co/developers.")
+
+    # Create a meeting token for the given room with an expiration 1 hour in
+    # the future.
+    room_name: str = urllib.parse.urlparse(url).path[1:]
+    expiration: float = time.time() + 60 * 60
+
+    res: requests.Response = requests.post(
+        f"https://api.daily.co/v1/meeting-tokens",
+        headers={
+            "Authorization": f"Bearer {key}"},
+        json={
+            "properties": {
+                "room_name": room_name,
+                "is_owner": True,
+                "exp": expiration}},
+    )
+
+    if res.status_code != 200:
+        raise Exception(
+            f"Failed to create meeting token: {res.status_code} {res.text}")
+
+    token: str = res.json()["token"]
+
+    return (url, token)

src/examples/starter-apps/storybot.py → examples/starter-apps/storybot.py

@@ -25,7 +25,6 @@
     UserResponseAggregator,
     LLMResponseAggregator,
 )
-from examples.support.runner import configure
 from dailyai.pipeline.frames import (
     EndPipeFrame,
     LLMMessagesQueueFrame,
@@ -43,6 +42,11 @@
 )
 from dailyai.services.ai_services import FrameLogger, AIService
 
+from runner import configure
+
+from dotenv import load_dotenv
+load_dotenv()
+
 logging.basicConfig(format=f"%(levelno)s %(asctime)s %(message)s")
 logger = logging.getLogger("dailyai")
 logger.setLevel(logging.DEBUG)

src/examples/starter-apps/translator.py → examples/starter-apps/translator.py

@@ -18,7 +18,11 @@
 from dailyai.services.azure_ai_services import AzureTTSService
 from dailyai.services.open_ai_services import OpenAILLMService
 from dailyai.services.elevenlabs_ai_service import ElevenLabsTTSService
-from examples.support.runner import configure
+
+from runner import configure
+
+from dotenv import load_dotenv
+load_dotenv()
 
 logging.basicConfig(format=f"%(levelno)s %(asctime)s %(message)s")
 logger = logging.getLogger("dailyai")