2023-05-14 00:30:19 +00:00
|
|
|
## 🚀 Getting Started
|
2023-05-12 02:08:52 +00:00
|
|
|
|
2023-05-14 00:30:19 +00:00
|
|
|
Follow these steps to set up and run ecoute on your local machine.
|
2023-05-13 01:18:44 +00:00
|
|
|
|
2023-05-14 00:30:19 +00:00
|
|
|
### 📋 Prerequisites
|
2023-05-13 01:18:58 +00:00
|
|
|
|
2023-05-14 00:30:19 +00:00
|
|
|
- Python 3.x
|
|
|
|
|
- An OpenAI API key
|
2023-05-13 19:49:49 +00:00
|
|
|
|
2023-05-14 00:30:19 +00:00
|
|
|
### 🔧 Installation
|
|
|
|
|
|
|
|
|
|
1. Clone the repository:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
git clone https://github.com/SevaSk/ecoute
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
2. Navigate to the `ecoute` folder:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
cd ecoute
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
3. Install the required packages:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
pip install -r requirements.txt
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
4. Create a `keys.py` file and add your OpenAI API key:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
echo 'OPENAI_API_KEY = "API KEY"' > keys.py
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Replace `API KEY` with your actual OpenAI API key.
|
|
|
|
|
|
|
|
|
|
### 🎬 Running ecoute
|
|
|
|
|
|
|
|
|
|
Run the main script:
|
|
|
|
|
|
|
|
|
|
```
|
2023-05-13 01:18:27 +00:00
|
|
|
python main.py
|
2023-05-14 00:30:19 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Now, ecoute will start transcribing your microphone input and speaker output in real-time, and provide a suggested response based on the conversation.
|
|
|
|
|
|
|
|
|
|
## 📖 License
|
|
|
|
|
|
|
|
|
|
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
|
|
|
|
|
|
|
|
|
## 🤝 Contributing
|
|
|
|
|
|
|
|
|
|
Contributions are welcome! Feel free to open issues or submit pull requests to improve ecoute.
|
|
|
|
|
```
|
