Merge pull request #2521 from PolicyEngine/fix/issue-2443

Created an example environment variable file

Author: anth-volk

.env.example

@@ -0,0 +1,18 @@
+# Path to the Google_Application_Credentials file
+# Required to run the simulation API
+GOOGLE_APPLICATION_CREDENTIALS=/path/to/policyengine_gcp_credentials.json
+
+# Password for connecting to the PolicyEngine database
+POLICYENGINE_DB_PASSWORD=policyengine_db_password
+
+# Github Microdata Token
+POLICYENGINE_GITHUB_MICRODATA_AUTH_TOKEN=policyengine_github_token
+
+# API key for Anthropic 
+ANTHROPIC_API_KEY=policyengine_anthropic_api_key
+
+# API Key for OpenAI
+OPENAI_API_KEY=policyengine_openai_api_key
+
+# Token for Hugging Face models 
+HUGGING_FACE_TOKEN=policyengine_huggingface_token

.github/setup_env.sh

@@ -0,0 +1,6 @@
+#! /usr/bin/env bash
+
+if [ ! -f .env ]; 
+then
+  cp .env.example .env
+fi

Makefile

@@ -1,5 +1,6 @@
 install:
 	pip install -e ".[dev]" --config-settings editable_mode=compat
+	bash .github/setup_env.sh
 
 debug:
 	FLASK_APP=policyengine_api.api FLASK_DEBUG=1 flask run --without-threads

changelog_entry.yaml

@@ -0,0 +1,5 @@
+- bump: patch
+  changes:
+    added:
+     - Added `.env.example` file with all relevant environment variables and example values for local setup.
+     - Modified Makefile `install` target to auto-copy `.env.example` to `.env` if `.env` does not exist.