.env.example with variables documentation (#25)

hastic-zzz · Oct 7, 2020 · 53e392a · 53e392a
1 parent 4e0a2a5
commit 53e392a
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 2 deletions.
diff --git a/.env.example b/.env.example
@@ -0,0 +1,6 @@
+# (optional) websockets URL to connect to hastic-server
+HASTIC_SERVER_URL=ws://localhost:8002
+# (optional) logging level: 'DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'
+HS_AN_LOGGING_LEVEL=DEBUG
+# (optional) time we wait for a response from hastic/analytics before sending the error
+LEARNING_TIMEOUT=120
diff --git a/.gitignore b/.gitignore
@@ -2,4 +2,5 @@ build/
 dist/
 *.spec
 __pycache__/
-test/
+test/
+.env
diff --git a/analytics/config.py b/analytics/config.py
@@ -1,6 +1,8 @@
 import os
 import json
+from dotenv import load_dotenv
 
+load_dotenv()
 
 PARENT_FOLDER = os.path.dirname(os.path.dirname(os.path.dirname(os.path.realpath(__file__))))
 CONFIG_FILE = os.path.join(PARENT_FOLDER, 'config.json')

diff --git a/requirements.txt b/requirements.txt
@@ -4,4 +4,5 @@ numpy==1.14.5
 pandas==0.20.3
 pyzmq==18.0.1
 scipy==1.1.0
-websockets==8.1
+websockets==8.1
+python-dotenv==0.14.0
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,4 +2,5 @@ build/ @@
     dist/
     *.spec
     __pycache__/
-    test/
+    test/
+    .env