Merge pull request #43 from Paulooh007/create-dotenv

Implement .env for secrets

Author: TimidRobot

README.md

@@ -48,6 +48,23 @@ modules:
 [pipenvinstall]: https://pipenv.pypa.io/en/latest/install/#installing-pipenv
 
 
+### Running Scripts that Require Client Credentials
+
+To successfully run scripts that require client credentials, you will need to follow these steps:
+  1. Copy the contents of the `env.example` file in the script's directory to `.env`:
+        ```
+        cp env.example .env
+        ```
+  2. Uncomment the variables in the `.env` file and assign values as needed. See [`sources.md`](sources.md) on how to get credentials:
+        ```
+        GOOGLE_API_KEYS=your_api_key
+        PSE_KEY=your_pse_key
+       ```
+  3. Save the changes to the `.env` file.
+
+  4. You should now be able to run scripts that require client credentials without any issues.
+
+
 ### Tooling
 
 - **[Python Guidelines — Creative Commons Open Source][ccospyguide]**
@@ -64,7 +81,7 @@ modules:
 
 ## Data Sources
 
-Kindly visit the [source.md](sources.md) file for it.
+Kindly visit the [sources.md](sources.md) file for it.
 
 
 ## History

deviantart/deviantart_scratcher.py

@@ -12,19 +12,22 @@
 
 # Third-party
 import pandas as pd
-import query_secrets
 import requests
+from dotenv import load_dotenv
 from requests.adapters import HTTPAdapter
 from urllib3.util.retry import Retry
 
+CWD = os.path.dirname(os.path.abspath(__file__))
+dotenv_path = os.path.join(os.path.dirname(CWD), ".env")
+load_dotenv(dotenv_path)
+
 today = dt.datetime.today()
-API_KEYS = query_secrets.API_KEYS
+API_KEYS = os.getenv("GOOGLE_API_KEYS").split(",")
 API_KEYS_IND = 0
-CWD = os.path.dirname(os.path.abspath(__file__))
 DATA_WRITE_FILE = (
     f"{CWD}" f"/data_deviantart_{today.year}_{today.month}_{today.day}.csv"
 )
-PSE_KEY = query_secrets.PSE_KEY
+PSE_KEY = os.getenv("PSE_KEY")
 
 
 def get_license_list():

deviantart/query_secrets.example.py

@@ -0,0 +1,41 @@
+## photos.py & photos_detail.py
+# "The flickr developer guide: https://www.flickr.com/services/developer/"
+
+# FLICKR_API_KEY = 
+# FLICKR_API_SECRET = 
+
+
+## deviantart_scratcher.py & google_scratcher.py 
+# "Custom Search JSON API requires the use of an API key. An API key is a way
+# to identify your client to Google."
+# https://developers.google.com/custom-search/v1/introduction
+
+# GOOGLE_API_KEYS = key1, key2
+
+# "The identifier of an engine created using the Programmable Search Engine
+# Control Panel [https://programmablesearchengine.google.com/about/]"
+# https://developers.google.com/custom-search/v1/reference/rest/v1/Search
+
+# PSE_KEY = 
+
+
+## vimeo_scratcher.py
+# "Before we set you loose on the API, we ask that you provide a little
+# information about your app. An app in this sense can be a full-featured
+# mobile application, a dynamic web page, or a three-line script. If it's
+# making API calls, it's an app."
+# https://developer.vimeo.com/api/guides/start#register-your-app
+
+# VIMEO_ACCESS_TOKEN = 
+# VIMEO_CLIENT_ID = 
+
+
+## youtube_scratcher.py
+# "Every request must either specify an API key (with the key parameter) [...].
+# Your API key is available in the Developer Console's API Access pane
+# [https://console.developers.google.com/] for your project."
+# https://developers.google.com/youtube/v3/docs
+
+# YOUTUBE_API_KEY = 
+
+

env.example

@@ -1,19 +1,24 @@
 # Standard library
 import json
+import os
 import os.path
 import sys
 import traceback
 
 # Third-party
 import flickrapi
-import query_secrets
+from dotenv import load_dotenv
 
 CWD = os.path.dirname(os.path.abspath(__file__))
+dotenv_path = os.path.join(os.path.dirname(CWD), ".env")
+load_dotenv(dotenv_path)
 
 
 def main():
     flickr = flickrapi.FlickrAPI(
-        query_secrets.api_key, query_secrets.api_secret, format="json"
+        os.getenv("FLICKR_API_KEY"),
+        os.getenv("FLICKR_API_SECRET"),
+        format="json",
     )
 
     # use search method to pull general photo info under each cc license data

flickr/photos.py

@@ -9,6 +9,7 @@
 
 # Standard library
 import json
+import os
 import os.path
 import sys
 import time
@@ -17,9 +18,12 @@
 # Third-party
 import flickrapi
 import pandas as pd
-import query_secrets
+from dotenv import load_dotenv
 
 CWD = os.path.dirname(os.path.abspath(__file__))
+dotenv_path = os.path.join(os.path.dirname(CWD), ".env")
+load_dotenv(dotenv_path)
+
 RETRIES = 0
 
 
@@ -149,7 +153,9 @@ def main():
     hs_csv_path = os.path.join(CWD, "hs.csv")
 
     flickr = flickrapi.FlickrAPI(
-        query_secrets.api_key, query_secrets.api_secret, format="json"
+        os.getenv("FLICKR_API_KEY"),
+        os.getenv("FLICKR_API_SECRET"),
+        format="json",
     )
     # below is the cc licenses list
     license_list = [1, 2, 3, 4, 5, 6, 9, 10]

flickr/photos_detail.py

@@ -12,15 +12,18 @@
 
 # Third-party
 import pandas as pd
-import query_secrets
 import requests
+from dotenv import load_dotenv
 from requests.adapters import HTTPAdapter
 from urllib3.util.retry import Retry
 
+CWD = os.path.dirname(os.path.abspath(__file__))
+dotenv_path = os.path.join(os.path.dirname(CWD), ".env")
+load_dotenv(dotenv_path)
+
 today = dt.datetime.today()
-API_KEYS = query_secrets.API_KEYS
+API_KEYS = os.getenv("GOOGLE_API_KEYS").split(",")
 API_KEYS_IND = 0
-CWD = os.path.dirname(os.path.abspath(__file__))
 DATA_WRITE_FILE = (
     f"{CWD}"
     f"/data_google_custom_search_{today.year}_{today.month}_{today.day}.csv"
@@ -36,7 +39,7 @@
     f"{today.year}_{today.month}_{today.day}.csv"
 )
 SEARCH_HALFYEAR_SPAN = 20
-PSE_KEY = query_secrets.PSE_KEY
+PSE_KEY = os.getenv("PSE_KEY")
 
 
 def get_license_list():

google_custom_search/google_scratcher.py

@@ -14,15 +14,18 @@
 import traceback
 
 # Third-party
-import query_secrets
 import requests
+from dotenv import load_dotenv
 from requests.adapters import HTTPAdapter
 from urllib3.util.retry import Retry
 
-today = dt.datetime.today()
-ACCESS_TOKEN = query_secrets.ACCESS_TOKEN
-CLIENT_ID = query_secrets.CLIENT_ID
 CWD = os.path.dirname(os.path.abspath(__file__))
+dotenv_path = os.path.join(os.path.dirname(CWD), ".env")
+load_dotenv(dotenv_path)
+
+today = dt.datetime.today()
+ACCESS_TOKEN = os.getenv("VIMEO_ACCESS_TOKEN")
+CLIENT_ID = os.getenv("VIMEO_CLIENT_ID")
 DATA_WRITE_FILE = (
     f"{CWD}" f"/data_vimeo_{today.year}_{today.month}_{today.day}.csv"
 )