diff --git a/README.md b/README.md index dc7a2ee18..bbdaf5af7 100644 --- a/README.md +++ b/README.md @@ -1 +1,41 @@ -# tk tk tk \ No newline at end of file +# dailyai SDK + +This SDK can help you build applications that participate in WebRTC meetings and use various AI services to interact with other participants. + +## Build/Install + +From the root of this repo, run the following: + +``` +pip install -r requirements.txt +python -m build +``` + +This builds the package. To use the package locally (eg to run sample files), run + +``` +pip install . +``` + +If you want to use this package from another directory, you can run: +``` +pip install path_to_this_repo +``` + +## Running the samples + +Tou can run the simple sample like so: + +``` +src/samples/simple-sample/simple-sample.py -u [YOUR_ROOM_URL] -k [YOUR_DAILY_API_KEY] +``` + +Note that the sample uses Azure's TTS and LLM services. You'll need to set the following environment variables for the sample to work: + +``` +AZURE_SPEECH_SERVICE_KEY +AZURE_SPEECH_SERVICE_REGION +AZURE_CHATGPT_KEY +AZURE_CHATGPT_ENDPOINT +AZURE_CHATGPT_DEPLOYMENT_ID +``` diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 000000000..6188992d0 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,3 @@ +build==1.0.3 +packaging==23.2 +pyproject_hooks==1.0.0