Skip to content

Commit

Permalink
add requirements.txt
Browse files Browse the repository at this point in the history
  • Loading branch information
jhakulin committed Nov 14, 2024
1 parent 57b53b4 commit 2b37b85
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 4 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,10 +78,15 @@ audio_capture = AudioCapture(audio_capture_event_handler, ...)

## Installation

1. **Build and install the wheel**:
- Build realtime-ai wheel using following command: `python setup.py sdist bdist_wheel`
- Go to generated `dist` folder
- Install the generated wheel using following command: `pip install --force-reinstall realtime_ai-0.1.0-py3-none-any.whl`
1. **Install the realtime AI Python library and dependencies**:

- Run the following command in your terminal to install all the necessary dependencies as specified in the requirements.txt file.
```
pip install -r requirements.txt
```

- Alternatively if you want to build the wheel yourself, use following command: `python setup.py sdist bdist_wheel`
- After that go to generated `dist` folder and install the generated wheel using following command: `pip install --force-reinstall realtime_ai-0.1.0-py3-none-any.whl`

2. **Setup**:
- Replace placeholders like `"OPENAI_API_KEY"` in the sample script with real information.
Expand Down
6 changes: 6 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
https://github.com/jhakulin/realtime-ai/releases/download/v0.1.0/realtime_ai-0.1.0-py3-none-any.whl
pyaudio
numpy
websockets
websocket-client
azure-cognitiveservices-speech

0 comments on commit 2b37b85

Please sign in to comment.