Skip to content

Commit af8e62a

Browse files
committed
Added .env.example with env variable examples
1 parent ab765f7 commit af8e62a

3 files changed

Lines changed: 24 additions & 0 deletions

File tree

.env.example

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Path to the Google_Application_Credentials file
2+
# Required to run the simulation API
3+
GOOGLE_APPLICATION_CREDENTIALS=/path/to/policyengine_gcp_credentials.json
4+
5+
# Password for connecting to the PolicyEngine database
6+
POLICYENGINE_DB_PASSWORD=policyengine_db_password
7+
8+
# Github Microdata Token
9+
POLICYENGINE_GITHUB_MICRODATA_AUTH_TOKEN=policyengine_github_token
10+
11+
# API key for Anthropic
12+
ANTHROPIC_API_KEY=policyengine_anthropic_api_key
13+
14+
# API Key for OpenAI
15+
OPENAI_API_KEY=policyengine_openai_api_key
16+
17+
# Token for Hugging Face models
18+
HUGGING_FACE_TOKEN=policyengine_huggingface_token

Makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
install:
22
pip install -e ".[dev]" --config-settings editable_mode=compat
3+
if [ ! -f .env ]; then cp .env.example .env; fi
34

45
debug:
56
FLASK_APP=policyengine_api.api FLASK_DEBUG=1 flask run --without-threads

changelog_entry.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
- bump: patch
2+
changes:
3+
added:
4+
- Added `.env.example` file with all relevant environment variables and example values for local setup.
5+
- Modified Makefile `install` target to auto-copy `.env.example` to `.env` if `.env` does not exist.

0 commit comments

Comments
 (0)