Add global env.example and rename env variables

Author: Paulooh007

README.md

@@ -51,13 +51,13 @@ modules:
 ### 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 `example.env` file in the script's directory to `.env`:
+  1. Copy the contents of the `env.example` file in the script's directory to `.env`:
         ```
-        cp example.env .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:
         ```
-        API_KEYS=your_api_key
+        GOOGLE_API_KEYS=your_api_key
         PSE_KEY=your_pse_key
        ```
   3. Save the changes to the `.env` file.

deviantart/deviantart_scratcher.py

@@ -22,7 +22,7 @@
 load_dotenv(dotenv_path)
 
 today = dt.datetime.today()
-API_KEYS = os.getenv("API_KEYS").split(",")
+API_KEYS = os.getenv("GOOGLE_API_KEYS").split(",")
 API_KEYS_IND = 0
 DATA_WRITE_FILE = (
     f"{CWD}" f"/data_deviantart_{today.year}_{today.month}_{today.day}.csv"

deviantart/example.env

@@ -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

@@ -16,7 +16,7 @@
 
 def main():
     flickr = flickrapi.FlickrAPI(
-        os.getenv("API_KEY"), os.getenv("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

@@ -153,7 +153,7 @@ def main():
     hs_csv_path = os.path.join(CWD, "hs.csv")
 
     flickr = flickrapi.FlickrAPI(
-        os.getenv("API_KEY"), os.getenv("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

@@ -22,7 +22,7 @@
 load_dotenv(dotenv_path)
 
 today = dt.datetime.today()
-API_KEYS = os.getenv("API_KEYS").split(",")
+API_KEYS = os.getenv("GOOGLE_API_KEYS").split(",")
 API_KEYS_IND = 0
 DATA_WRITE_FILE = (
     f"{CWD}"

google_custom_search/example.env

@@ -24,8 +24,8 @@
 load_dotenv(dotenv_path)
 
 today = dt.datetime.today()
-ACCESS_TOKEN = os.getenv("ACCESS_TOKEN")
-CLIENT_ID = os.getenv("CLIENT_ID")
+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"
 )