From 426a6b217685ab22aef46d21bbabd6cb65fd2b5f Mon Sep 17 00:00:00 2001 From: danielorf Date: Wed, 24 Feb 2021 21:35:41 -0800 Subject: [PATCH 1/2] Added environment variable option to config_terminal vars --- README.md | 6 +++++- config_terminal.py | 24 +++++++++++++----------- 2 files changed, 18 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index d2174ecf9fd..a0e6cee8a7b 100644 --- a/README.md +++ b/README.md @@ -228,7 +228,11 @@ These are the ones where a key is necessary: * Reddit: https://www.reddit.com/prefs/apps * Twitter: https://developer.twitter.com -When these are obtained, don't forget to update [config_terminal.txt](/config_terminal.py) +When these are obtained, don't forget to update [config_terminal.py](/config_terminal.py). Alternatively, you can also set them to the following environment variables: GT_API_KEY_ALPHAVANTAGE, GT_API_KEY_FINANCIALMODELINGPREP, GT_API_KEY_QUANDL, GT_API_REDDIT_CLIENT_ID, GT_API_REDDIT_CLIENT_SECRET, GT_API_REDDIT_USERNAME, GT_API_REDDIT_USER_AGENT, GT_API_REDDIT_PASSWORD, GT_API_TWITTER_KEY, GT_API_TWITTER_SECRET_KEY, and API_TWITTER_BEARER_TOKEN. + +``` +export GT_API_KEY_ALPHAVANTAGE="some_api_key" +``` ## Disclaimer diff --git a/config_terminal.py b/config_terminal.py index 4584e641471..86d757881b6 100644 --- a/config_terminal.py +++ b/config_terminal.py @@ -1,20 +1,22 @@ +import os + # https://www.alphavantage.co -API_KEY_ALPHAVANTAGE = "REPLACE_ME" +API_KEY_ALPHAVANTAGE = os.getenv("GT_API_KEY_ALPHAVANTAGE") or "REPLACE_ME" # https://financialmodelingprep.com/developer -API_KEY_FINANCIALMODELINGPREP = "REPLACE_ME" +API_KEY_FINANCIALMODELINGPREP = os.getenv("GT_API_KEY_FINANCIALMODELINGPREP") or "REPLACE_ME" # https://www.quandl.com/tools/api -API_KEY_QUANDL = "REPLACE_ME" +API_KEY_QUANDL = os.getenv("GT_API_KEY_QUANDL") or "REPLACE_ME" # https://www.reddit.com/prefs/apps -API_REDDIT_CLIENT_ID = "REPLACE_ME" -API_REDDIT_CLIENT_SECRET = "REPLACE_ME" -API_REDDIT_USERNAME = "REPLACE_ME" -API_REDDIT_USER_AGENT = "REPLACE_ME" -API_REDDIT_PASSWORD = "REPLACE_ME" +API_REDDIT_CLIENT_ID = os.getenv("GT_API_REDDIT_CLIENT_ID") or "REPLACE_ME" +API_REDDIT_CLIENT_SECRET = os.getenv("GT_API_REDDIT_CLIENT_SECRET") or "REPLACE_ME" +API_REDDIT_USERNAME = os.getenv("GT_API_REDDIT_USERNAME") or "REPLACE_ME" +API_REDDIT_USER_AGENT = os.getenv("GT_API_REDDIT_USER_AGENT") or "REPLACE_ME" +API_REDDIT_PASSWORD = os.getenv("GT_API_REDDIT_PASSWORD") or "REPLACE_ME" # https://developer.twitter.com -API_TWITTER_KEY = "REPLACE_ME" -API_TWITTER_SECRET_KEY = "REPLACE_ME" -API_TWITTER_BEARER_TOKEN = "REPLACE_ME" +API_TWITTER_KEY = os.getenv("GT_API_TWITTER_KEY") or "REPLACE_ME" +API_TWITTER_SECRET_KEY = os.getenv("GT_API_TWITTER_SECRET_KEY") or "REPLACE_ME" +API_TWITTER_BEARER_TOKEN = os.getenv("GT_API_TWITTER_BEARER_TOKEN") or "REPLACE_ME" From c5111e53ca606460305e1883d0b24c71875a0995 Mon Sep 17 00:00:00 2001 From: danielorf Date: Wed, 24 Feb 2021 21:39:40 -0800 Subject: [PATCH 2/2] fix readme format --- README.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a0e6cee8a7b..d17d44329aa 100644 --- a/README.md +++ b/README.md @@ -228,11 +228,18 @@ These are the ones where a key is necessary: * Reddit: https://www.reddit.com/prefs/apps * Twitter: https://developer.twitter.com -When these are obtained, don't forget to update [config_terminal.py](/config_terminal.py). Alternatively, you can also set them to the following environment variables: GT_API_KEY_ALPHAVANTAGE, GT_API_KEY_FINANCIALMODELINGPREP, GT_API_KEY_QUANDL, GT_API_REDDIT_CLIENT_ID, GT_API_REDDIT_CLIENT_SECRET, GT_API_REDDIT_USERNAME, GT_API_REDDIT_USER_AGENT, GT_API_REDDIT_PASSWORD, GT_API_TWITTER_KEY, GT_API_TWITTER_SECRET_KEY, and API_TWITTER_BEARER_TOKEN. - -``` -export GT_API_KEY_ALPHAVANTAGE="some_api_key" -``` +When these are obtained, don't forget to update [config_terminal.py](/config_terminal.py). Alternatively, you can also set them to the following environment variables: + * GT_API_KEY_ALPHAVANTAGE + * GT_API_KEY_FINANCIALMODELINGPREP + * GT_API_KEY_QUANDL + * GT_API_REDDIT_CLIENT_ID + * GT_API_REDDIT_CLIENT_SECRET + * GT_API_REDDIT_USERNAME + * GT_API_REDDIT_USER_AGENT + * GT_API_REDDIT_PASSWORD + * GT_API_TWITTER_KEY + * GT_API_TWITTER_SECRET_KEY + * GT_API_TWITTER_BEARER_TOKEN. ## Disclaimer