diff --git a/README.md b/README.md index d852245a2..dc418857a 100644 --- a/README.md +++ b/README.md @@ -60,15 +60,15 @@ 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 +python 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 diff --git a/docs/README.md b/docs/README.md index c3be534f0..9db83ac11 100644 --- a/docs/README.md +++ b/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/) diff --git a/docs/examples/01-say-one-thing.md b/docs/examples/01-say-one-thing.md index 319c89960..3d8231ded 100644 --- a/docs/examples/01-say-one-thing.md +++ b/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 diff --git a/docs/examples/README.md b/docs/examples/README.md index ba3f6f45d..dea68ffc9 100644 --- a/docs/examples/README.md +++ b/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). diff --git a/src/examples/foundational/01-say-one-thing.py b/examples/foundational/01-say-one-thing.py similarity index 100% rename from src/examples/foundational/01-say-one-thing.py rename to examples/foundational/01-say-one-thing.py diff --git a/src/examples/foundational/01a-local-transport.py b/examples/foundational/01a-local-transport.py similarity index 100% rename from src/examples/foundational/01a-local-transport.py rename to examples/foundational/01a-local-transport.py diff --git a/src/examples/foundational/02-llm-say-one-thing.py b/examples/foundational/02-llm-say-one-thing.py similarity index 100% rename from src/examples/foundational/02-llm-say-one-thing.py rename to examples/foundational/02-llm-say-one-thing.py diff --git a/src/examples/foundational/03-still-frame.py b/examples/foundational/03-still-frame.py similarity index 100% rename from src/examples/foundational/03-still-frame.py rename to examples/foundational/03-still-frame.py diff --git a/src/examples/foundational/03a-image-local.py b/examples/foundational/03a-image-local.py similarity index 100% rename from src/examples/foundational/03a-image-local.py rename to examples/foundational/03a-image-local.py diff --git a/src/examples/foundational/04-utterance-and-speech.py b/examples/foundational/04-utterance-and-speech.py similarity index 100% rename from src/examples/foundational/04-utterance-and-speech.py rename to examples/foundational/04-utterance-and-speech.py diff --git a/src/examples/foundational/05-sync-speech-and-image.py b/examples/foundational/05-sync-speech-and-image.py similarity index 100% rename from src/examples/foundational/05-sync-speech-and-image.py rename to examples/foundational/05-sync-speech-and-image.py diff --git a/src/examples/foundational/05a-local-sync-speech-and-text.py b/examples/foundational/05a-local-sync-speech-and-text.py similarity index 100% rename from src/examples/foundational/05a-local-sync-speech-and-text.py rename to examples/foundational/05a-local-sync-speech-and-text.py diff --git a/src/examples/foundational/06-listen-and-respond.py b/examples/foundational/06-listen-and-respond.py similarity index 100% rename from src/examples/foundational/06-listen-and-respond.py rename to examples/foundational/06-listen-and-respond.py diff --git a/src/examples/foundational/06a-image-sync.py b/examples/foundational/06a-image-sync.py similarity index 100% rename from src/examples/foundational/06a-image-sync.py rename to examples/foundational/06a-image-sync.py diff --git a/src/examples/foundational/07-interruptible.py b/examples/foundational/07-interruptible.py similarity index 100% rename from src/examples/foundational/07-interruptible.py rename to examples/foundational/07-interruptible.py diff --git a/src/examples/foundational/08-bots-arguing.py b/examples/foundational/08-bots-arguing.py similarity index 100% rename from src/examples/foundational/08-bots-arguing.py rename to examples/foundational/08-bots-arguing.py diff --git a/src/examples/foundational/10-wake-word.py b/examples/foundational/10-wake-word.py similarity index 100% rename from src/examples/foundational/10-wake-word.py rename to examples/foundational/10-wake-word.py diff --git a/src/examples/foundational/11-sound-effects.py b/examples/foundational/11-sound-effects.py similarity index 100% rename from src/examples/foundational/11-sound-effects.py rename to examples/foundational/11-sound-effects.py diff --git a/src/examples/foundational/13-whisper-transcription.py b/examples/foundational/13-whisper-transcription.py similarity index 100% rename from src/examples/foundational/13-whisper-transcription.py rename to examples/foundational/13-whisper-transcription.py diff --git a/src/examples/foundational/13a-whisper-local.py b/examples/foundational/13a-whisper-local.py similarity index 100% rename from src/examples/foundational/13a-whisper-local.py rename to examples/foundational/13a-whisper-local.py diff --git a/src/examples/foundational/assets/ding1.wav b/examples/foundational/assets/ding1.wav similarity index 100% rename from src/examples/foundational/assets/ding1.wav rename to examples/foundational/assets/ding1.wav diff --git a/src/examples/foundational/assets/ding2.wav b/examples/foundational/assets/ding2.wav similarity index 100% rename from src/examples/foundational/assets/ding2.wav rename to examples/foundational/assets/ding2.wav diff --git a/src/examples/foundational/assets/sc-default.png b/examples/foundational/assets/sc-default.png similarity index 100% rename from src/examples/foundational/assets/sc-default.png rename to examples/foundational/assets/sc-default.png diff --git a/src/examples/foundational/assets/sc-listen-1.png b/examples/foundational/assets/sc-listen-1.png similarity index 100% rename from src/examples/foundational/assets/sc-listen-1.png rename to examples/foundational/assets/sc-listen-1.png diff --git a/src/examples/foundational/assets/sc-listen-2.png b/examples/foundational/assets/sc-listen-2.png similarity index 100% rename from src/examples/foundational/assets/sc-listen-2.png rename to examples/foundational/assets/sc-listen-2.png diff --git a/src/examples/foundational/assets/sc-talk.png b/examples/foundational/assets/sc-talk.png similarity index 100% rename from src/examples/foundational/assets/sc-talk.png rename to examples/foundational/assets/sc-talk.png diff --git a/src/examples/foundational/assets/sc-think-1.png b/examples/foundational/assets/sc-think-1.png similarity index 100% rename from src/examples/foundational/assets/sc-think-1.png rename to examples/foundational/assets/sc-think-1.png diff --git a/src/examples/foundational/assets/sc-think-2.png b/examples/foundational/assets/sc-think-2.png similarity index 100% rename from src/examples/foundational/assets/sc-think-2.png rename to examples/foundational/assets/sc-think-2.png diff --git a/src/examples/foundational/assets/sc-think-3.png b/examples/foundational/assets/sc-think-3.png similarity index 100% rename from src/examples/foundational/assets/sc-think-3.png rename to examples/foundational/assets/sc-think-3.png diff --git a/src/examples/foundational/assets/sc-think-4.png b/examples/foundational/assets/sc-think-4.png similarity index 100% rename from src/examples/foundational/assets/sc-think-4.png rename to examples/foundational/assets/sc-think-4.png diff --git a/src/examples/foundational/assets/speaking.png b/examples/foundational/assets/speaking.png similarity index 100% rename from src/examples/foundational/assets/speaking.png rename to examples/foundational/assets/speaking.png diff --git a/src/examples/foundational/assets/waiting.png b/examples/foundational/assets/waiting.png similarity index 100% rename from src/examples/foundational/assets/waiting.png rename to examples/foundational/assets/waiting.png diff --git a/src/examples/image-gen.py b/examples/image-gen.py similarity index 100% rename from src/examples/image-gen.py rename to examples/image-gen.py diff --git a/src/examples/internal/11a-dial-out.py b/examples/internal/11a-dial-out.py similarity index 100% rename from src/examples/internal/11a-dial-out.py rename to examples/internal/11a-dial-out.py diff --git a/src/examples/server/Dockerfile b/examples/server/Dockerfile similarity index 100% rename from src/examples/server/Dockerfile rename to examples/server/Dockerfile diff --git a/src/examples/server/README.md b/examples/server/README.md similarity index 100% rename from src/examples/server/README.md rename to examples/server/README.md diff --git a/src/examples/server/auth.py b/examples/server/auth.py similarity index 100% rename from src/examples/server/auth.py rename to examples/server/auth.py diff --git a/src/examples/server/daily-bot-manager.py b/examples/server/daily-bot-manager.py similarity index 97% rename from src/examples/server/daily-bot-manager.py rename to examples/server/daily-bot-manager.py index f59d7fc67..64d48e9a9 100644 --- a/src/examples/server/daily-bot-manager.py +++ b/examples/server/daily-bot-manager.py @@ -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") diff --git a/src/examples/starter-apps/assets/clack-short-quiet.wav b/examples/starter-apps/assets/clack-short-quiet.wav similarity index 100% rename from src/examples/starter-apps/assets/clack-short-quiet.wav rename to examples/starter-apps/assets/clack-short-quiet.wav diff --git a/src/examples/starter-apps/assets/clack-short.wav b/examples/starter-apps/assets/clack-short.wav similarity index 100% rename from src/examples/starter-apps/assets/clack-short.wav rename to examples/starter-apps/assets/clack-short.wav diff --git a/src/examples/starter-apps/assets/clack.wav b/examples/starter-apps/assets/clack.wav similarity index 100% rename from src/examples/starter-apps/assets/clack.wav rename to examples/starter-apps/assets/clack.wav diff --git a/src/examples/starter-apps/assets/ding.wav b/examples/starter-apps/assets/ding.wav similarity index 100% rename from src/examples/starter-apps/assets/ding.wav rename to examples/starter-apps/assets/ding.wav diff --git a/src/examples/starter-apps/assets/ding2.wav b/examples/starter-apps/assets/ding2.wav similarity index 100% rename from src/examples/starter-apps/assets/ding2.wav rename to examples/starter-apps/assets/ding2.wav diff --git a/src/examples/starter-apps/assets/ding3.wav b/examples/starter-apps/assets/ding3.wav similarity index 100% rename from src/examples/starter-apps/assets/ding3.wav rename to examples/starter-apps/assets/ding3.wav diff --git a/src/examples/starter-apps/assets/grandma-listening.png b/examples/starter-apps/assets/grandma-listening.png similarity index 100% rename from src/examples/starter-apps/assets/grandma-listening.png rename to examples/starter-apps/assets/grandma-listening.png diff --git a/src/examples/starter-apps/assets/grandma-writing.png b/examples/starter-apps/assets/grandma-writing.png similarity index 100% rename from src/examples/starter-apps/assets/grandma-writing.png rename to examples/starter-apps/assets/grandma-writing.png diff --git a/src/examples/starter-apps/assets/listening.wav b/examples/starter-apps/assets/listening.wav similarity index 100% rename from src/examples/starter-apps/assets/listening.wav rename to examples/starter-apps/assets/listening.wav diff --git a/src/examples/starter-apps/assets/robot01.png b/examples/starter-apps/assets/robot01.png similarity index 100% rename from src/examples/starter-apps/assets/robot01.png rename to examples/starter-apps/assets/robot01.png diff --git a/src/examples/starter-apps/assets/robot010.png b/examples/starter-apps/assets/robot010.png similarity index 100% rename from src/examples/starter-apps/assets/robot010.png rename to examples/starter-apps/assets/robot010.png diff --git a/src/examples/starter-apps/assets/robot011.png b/examples/starter-apps/assets/robot011.png similarity index 100% rename from src/examples/starter-apps/assets/robot011.png rename to examples/starter-apps/assets/robot011.png diff --git a/src/examples/starter-apps/assets/robot012.png b/examples/starter-apps/assets/robot012.png similarity index 100% rename from src/examples/starter-apps/assets/robot012.png rename to examples/starter-apps/assets/robot012.png diff --git a/src/examples/starter-apps/assets/robot013.png b/examples/starter-apps/assets/robot013.png similarity index 100% rename from src/examples/starter-apps/assets/robot013.png rename to examples/starter-apps/assets/robot013.png diff --git a/src/examples/starter-apps/assets/robot014.png b/examples/starter-apps/assets/robot014.png similarity index 100% rename from src/examples/starter-apps/assets/robot014.png rename to examples/starter-apps/assets/robot014.png diff --git a/src/examples/starter-apps/assets/robot015.png b/examples/starter-apps/assets/robot015.png similarity index 100% rename from src/examples/starter-apps/assets/robot015.png rename to examples/starter-apps/assets/robot015.png diff --git a/src/examples/starter-apps/assets/robot016.png b/examples/starter-apps/assets/robot016.png similarity index 100% rename from src/examples/starter-apps/assets/robot016.png rename to examples/starter-apps/assets/robot016.png diff --git a/src/examples/starter-apps/assets/robot017.png b/examples/starter-apps/assets/robot017.png similarity index 100% rename from src/examples/starter-apps/assets/robot017.png rename to examples/starter-apps/assets/robot017.png diff --git a/src/examples/starter-apps/assets/robot018.png b/examples/starter-apps/assets/robot018.png similarity index 100% rename from src/examples/starter-apps/assets/robot018.png rename to examples/starter-apps/assets/robot018.png diff --git a/src/examples/starter-apps/assets/robot019.png b/examples/starter-apps/assets/robot019.png similarity index 100% rename from src/examples/starter-apps/assets/robot019.png rename to examples/starter-apps/assets/robot019.png diff --git a/src/examples/starter-apps/assets/robot02.png b/examples/starter-apps/assets/robot02.png similarity index 100% rename from src/examples/starter-apps/assets/robot02.png rename to examples/starter-apps/assets/robot02.png diff --git a/src/examples/starter-apps/assets/robot020.png b/examples/starter-apps/assets/robot020.png similarity index 100% rename from src/examples/starter-apps/assets/robot020.png rename to examples/starter-apps/assets/robot020.png diff --git a/src/examples/starter-apps/assets/robot021.png b/examples/starter-apps/assets/robot021.png similarity index 100% rename from src/examples/starter-apps/assets/robot021.png rename to examples/starter-apps/assets/robot021.png diff --git a/src/examples/starter-apps/assets/robot022.png b/examples/starter-apps/assets/robot022.png similarity index 100% rename from src/examples/starter-apps/assets/robot022.png rename to examples/starter-apps/assets/robot022.png diff --git a/src/examples/starter-apps/assets/robot023.png b/examples/starter-apps/assets/robot023.png similarity index 100% rename from src/examples/starter-apps/assets/robot023.png rename to examples/starter-apps/assets/robot023.png diff --git a/src/examples/starter-apps/assets/robot024.png b/examples/starter-apps/assets/robot024.png similarity index 100% rename from src/examples/starter-apps/assets/robot024.png rename to examples/starter-apps/assets/robot024.png diff --git a/src/examples/starter-apps/assets/robot025.png b/examples/starter-apps/assets/robot025.png similarity index 100% rename from src/examples/starter-apps/assets/robot025.png rename to examples/starter-apps/assets/robot025.png diff --git a/src/examples/starter-apps/assets/robot03.png b/examples/starter-apps/assets/robot03.png similarity index 100% rename from src/examples/starter-apps/assets/robot03.png rename to examples/starter-apps/assets/robot03.png diff --git a/src/examples/starter-apps/assets/robot04.png b/examples/starter-apps/assets/robot04.png similarity index 100% rename from src/examples/starter-apps/assets/robot04.png rename to examples/starter-apps/assets/robot04.png diff --git a/src/examples/starter-apps/assets/robot05.png b/examples/starter-apps/assets/robot05.png similarity index 100% rename from src/examples/starter-apps/assets/robot05.png rename to examples/starter-apps/assets/robot05.png diff --git a/src/examples/starter-apps/assets/robot06.png b/examples/starter-apps/assets/robot06.png similarity index 100% rename from src/examples/starter-apps/assets/robot06.png rename to examples/starter-apps/assets/robot06.png diff --git a/src/examples/starter-apps/assets/robot07.png b/examples/starter-apps/assets/robot07.png similarity index 100% rename from src/examples/starter-apps/assets/robot07.png rename to examples/starter-apps/assets/robot07.png diff --git a/src/examples/starter-apps/assets/robot08.png b/examples/starter-apps/assets/robot08.png similarity index 100% rename from src/examples/starter-apps/assets/robot08.png rename to examples/starter-apps/assets/robot08.png diff --git a/src/examples/starter-apps/assets/robot09.png b/examples/starter-apps/assets/robot09.png similarity index 100% rename from src/examples/starter-apps/assets/robot09.png rename to examples/starter-apps/assets/robot09.png diff --git a/src/examples/starter-apps/assets/talking.wav b/examples/starter-apps/assets/talking.wav similarity index 100% rename from src/examples/starter-apps/assets/talking.wav rename to examples/starter-apps/assets/talking.wav diff --git a/src/examples/starter-apps/chatbot.py b/examples/starter-apps/chatbot.py similarity index 100% rename from src/examples/starter-apps/chatbot.py rename to examples/starter-apps/chatbot.py diff --git a/src/examples/starter-apps/patient-intake.py b/examples/starter-apps/patient-intake.py similarity index 100% rename from src/examples/starter-apps/patient-intake.py rename to examples/starter-apps/patient-intake.py diff --git a/src/examples/starter-apps/storybot.py b/examples/starter-apps/storybot.py similarity index 100% rename from src/examples/starter-apps/storybot.py rename to examples/starter-apps/storybot.py diff --git a/src/examples/starter-apps/translator.py b/examples/starter-apps/translator.py similarity index 100% rename from src/examples/starter-apps/translator.py rename to examples/starter-apps/translator.py diff --git a/src/examples/support/runner.py b/examples/support/runner.py similarity index 100% rename from src/examples/support/runner.py rename to examples/support/runner.py