Makes OPENAI_API_KEY required

a115 · Apr 14, 2024 · 1c1afa2 · 1c1afa2
1 parent 05296a8
commit 1c1afa2
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -18,6 +18,8 @@ iCODES requires Python 3.11 or higher.
 
     pip install icodes
 
+Since the only supported LLM backend right now is OpenAI, you will need to export your OpenAI API key to the environment variable `OPENAI_API_KEY`. You can also set the `DEFAULT_MODEL` environment variable to the GPT model you wish to use (default value is "gpt-3.5-turbo" for a reasonable price / quality ratio.)
+
 ### Alternative installation 
 
 Or clone the repo:

diff --git a/icds/settings.py b/icds/settings.py
@@ -4,7 +4,7 @@
 class Settings(BaseSettings):
     DEBUG: bool = False
     DATABASE_URL: str = "sqlite:///./icodes.db"
-    OPENAI_API_KEY: str = ""
+    OPENAI_API_KEY: str
     DEFAULT_MODEL: str = "gpt-3.5-turbo"
 
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "icodes"
-version = "0.1.1"
+version = "0.1.3"
 description = "LLM-powered Git archeology tool (a.k.a. Intelligent Commit Ontology Distiller and Enhanced Search)"
 authors = ["Jordan Dimov <[email protected]>", "Bayo Ade <[email protected]>"]
 license = "CC0-1.0"