Add Support for .env File Configuration (#107)

Co-authored-by: Kazuhiro Sera <[email protected]>

.env.example

@@ -0,0 +1,3 @@
+OPENAI_API_KEY=sk-...
+SLACK_BOT_TOKEN=xoxb-...
+SLACK_APP_TOKEN=xapp-1-...

README.md

@@ -125,6 +125,20 @@ pip install -r requirements.txt
 python main.py
 ```
 
+### Using .env for credential loading
+
+If you prefer using .env file to load env variables for local development, you can rename .env.example file to .env:
+
+```bash
+cp .env.example .env
+```
+Then, replace the values in .env file with your own API keys and tokens:
+```text
+OPENAI_API_KEY=sk-your-openai-key
+SLACK_BOT_TOKEN=xoxb-your-slack-bot-token
+SLACK_APP_TOKEN=xapp-1-your-slack-app-token
+```
+
 ## Running the App for Company Workspaces
 
 Confidentiality of information is top priority for businesses.

main.py

@@ -1,3 +1,4 @@
+from dotenv import load_dotenv
 import logging
 import os
 
@@ -21,6 +22,7 @@
 )
 from app.slack_ui import build_home_tab
 
+load_dotenv()
 
 if __name__ == "__main__":
     from slack_bolt.adapter.socket_mode import SocketModeHandler

requirements.txt

@@ -5,4 +5,5 @@ tiktoken>=0.7,<0.8
 # https://github.com/Yelp/elastalert/issues/2306
 urllib3<2
 pillow>=10.4.0,<11
-requests>=2.32,<3
+requests>=2.32,<3
+python-dotenv>=1.0.1,<2