aljaz/Auto-GPT
1
0
Fork 0
mirror of https://github.com/aljazceru/Auto-GPT.git synced 2025-12-17 22:14:28 +01:00
Code Issues Packages Projects Releases Wiki Activity

Remove keys.py and replace with python-dotenv.

Browse Source 
- Removed `keys.py`.
- Added `.env.template`.
- Added `.env` to `.gitignore`.
- Updated various files that imported `keys` to use `os.getenv` instead.
- Updated `requirements.txt` dependencies.
- Updated README.md with instructions on setting up environment variables.

This change improves security, flexibility, and makes it easier to use Auto-GPT in notebooks. Environment variables are stored in `.env` and loaded via `load_dotenv()` in `scripts/main.py`.
This commit is contained in:
James C. Palmer
2023-04-02 06:11:04 -04:00
parent cffe083ff2
commit ef656a0f77
8 changed files with 28 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.env.template Normal file
View File

@@ -0,0 +1,2 @@
OPENAI_API_KEY=your-openai-api-key
ELEVENLABS_API_KEY=your-elevenlabs-api-key

3
.gitignore vendored
View File

@@ -5,4 +5,5 @@ scripts/__pycache__/keys.cpython-310.pyc
package-lock.json package-lock.json
*.pyc *.pyc
scripts/auto_gpt_workspace/* scripts/auto_gpt_workspace/*
*.mpeg *.mpeg
.env

17
README.md
View File

@@ -65,7 +65,7 @@ git clone https://github.com/Torantulino/Auto-GPT.git
``` ```
2. Navigate to the project directory: 2. Navigate to the project directory:
*(Type this into your CMD window, you're aiming to navigate the CMD window to the "scripts" folder you just downloaded)* *(Type this into your CMD window, you're aiming to navigate the CMD window to the repository you just downloaded)*
``` ```
$ cd 'Auto-GPT' $ cd 'Auto-GPT'
``` ```
@@ -76,22 +76,23 @@ $ cd 'Auto-GPT'
pip install -r requirements.txt pip install -r requirements.txt
``` ```
4. Edit the file named "keys.py" in the "scripts" directory to add your OpenAI API key (and eleven labs key if you want speech): 4. Rename `.env.template` to `.env` and fill in your `OPENAI_API_KEY`. If you plan to use Speech Mode, fill in your `ELEVEN_LABS_API_KEY` as well.
*(Open the keys.py file in a text editor and follow the instructions inside, save it after)* - Obtain your OpenAI API key from: https://platform.openai.com/account/api-keys.
- Obtain your ElevenLabs API key from: https://elevenlabs.io. You can view your xi-api-key using the "Profile" tab on the website.
## 🔧 Usage ## 🔧 Usage
1. Run the Python script in your terminal: 1. Run the `main.py` Python script in your terminal:
*(Type this into your CMD window)* *(Type this into your CMD window)*
``` ```
python main.py python scripts/main.py
``` ```
2. After each of AUTO-GPT's actions, type "NEXT COMMAND" to authorise them to continue. 2. After each of AUTO-GPT's actions, type "NEXT COMMAND" to authorise them to continue.
3. To exit the program, type "exit" and press Enter. 3. To exit the program, type "exit" and press Enter.
## 🗣️ Speech Mode ## 🗣️ Speech Mode
``` ```
python main.py speach-mode python scripts/main.py speach-mode
``` ```
## 💀 Continuous Mode ⚠️ ## 💀 Continuous Mode ⚠️
@@ -100,9 +101,9 @@ Continuous mode is not recommended.
It is potentially dangerous and may cause your AI to run forever or carry out actions you would not usually authorise. It is potentially dangerous and may cause your AI to run forever or carry out actions you would not usually authorise.
Use at your own risk. Use at your own risk.
1. Run the Python script in your terminal: 1. Run the `main.py` Python script in your terminal:
``` ```
python main.py continuous-mode python scripts/main.py continuous-mode
``` ```
2. To exit the program, press Ctrl + C 2. To exit the program, press Ctrl + C

11
requirements.txt
View File

@@ -1,8 +1,9 @@
beautifulsoup4==4.9.3 beautifulsoup4==4.9.3
colorama==0.4.6 colorama==0.4.6
googlesearch_python==1.1.0 docker==5.0.3
openai==0.27.0 googlesearch-python==1.1.0
playsound==1.2.2 openai==0.27.2
readability_lxml==0.8.1 playsound==1.3.0
python-dotenv==1.0.0
readability-lxml==0.8.1
requests==2.25.1 requests==2.25.1
docker==6.0.1

4
scripts/chat.py
View File

@@ -1,9 +1,9 @@
import os
import time import time
import openai import openai
import keys
# Initialize the OpenAI API client # Initialize the OpenAI API client
openai.api_key = keys.OPENAI_API_KEY openai.api_key = os.getenv("OPENAI_API_KEY")
def create_chat_message(role, content): def create_chat_message(role, content):

5
scripts/keys.py
View File

@@ -1,5 +0,0 @@
# Get yours from: https://beta.openai.com/account/api-keys
OPENAI_API_KEY = "YOUR-OPENAI-KEY"
# To access your ElevenLabs API key, head to https://elevenlabs.io, you
# can view your xi-api-key using the 'Profile' tab on the website.
ELEVENLABS_API_KEY = "YOUR-ELEVENLABS-KEY"

5
scripts/main.py
View File

@@ -11,6 +11,11 @@ import speak
from enum import Enum, auto from enum import Enum, auto
import sys import sys
from config import Config from config import Config
from dotenv import load_dotenv
# Load environment variables from .env file
load_dotenv()
class Argument(Enum): class Argument(Enum):

4
scripts/speak.py
View File

@@ -1,13 +1,13 @@
import os import os
from playsound import playsound from playsound import playsound
import requests import requests
import keys
voices = ["ErXwobaYiN019PkySvjV", "EXAVITQu4vr4xnSDxMaL"] voices = ["ErXwobaYiN019PkySvjV", "EXAVITQu4vr4xnSDxMaL"]
tts_headers = { tts_headers = {
"Content-Type": "application/json", "Content-Type": "application/json",
"xi-api-key": keys.ELEVENLABS_API_KEY "xi-api-key": os.getenv("ELEVENLABS_API_KEY")
} }