jcarr
/
narrator-david-attenburo
mirror of https://github.com/cbh123/narrator.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated README with .env file instructions

This commit is contained in:
Gennings, Matt 2024-01-09 11:34:08 -06:00
parent b083594e2e
commit b80925fb4d
1 changed files with 17 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -20,11 +20,24 @@ Then, install the dependencies:
Make a [Replicate](https://replicate.com), [OpenAI](https://beta.openai.com/), and [ElevenLabs](https://elevenlabs.io) account and set your tokens:
```
export OPENAI_API_KEY=<token>
export ELEVENLABS_API_KEY=<eleven-token>
```
### Setting Up Environment Variables
Instead of setting your tokens directly in the terminal, we'll use a `.env` file to manage them securely. Follow these steps:
1. Create a file named `.env` in the root directory of your project.
2. Add your API keys and voice ID to the `.env` file in the following format:
```
OPENAI_API_KEY=your_openai_api_key
ELEVENLABS_API_KEY=your_elevenlabs_api_key
ELEVENLABS_VOICE_ID=your_elevenlabs_voice_id
```
Replace `your_openai_api_key`, `your_elevenlabs_api_key`, and `your_elevenlabs_voice_id` with your actual keys and ID.
3. The python-dotenv package (already included in `requirements.txt`) will load these variables automatically.
**Note:** Ensure that `.env` is listed in your `.gitignore` file to keep your API keys secure.
Make a new voice in Eleven and get the voice id of that voice using their [get voices](https://elevenlabs.io/docs/api-reference/voices) API, or by clicking the flask icon next to the voice in the VoiceLab tab.
```