required changes applied

Author: itisQaisar

README.md

@@ -133,7 +133,7 @@ directories to check:
 - [ppypa/pipenv][pipenv]: _Python Development Workflow for Humans._
 - [pre-commit][pre-commit]: _A framework for managing and maintaining
   multi-language pre-commit hooks._
-  [Logging][logging]: _Utilize the built-in Python logging module to implement a flexible logging system from a shared module._
+- [Logging][logging]: _Utilize the built-in Python logging module to implement a flexible logging system from a shared module._
 
 [ccospyguide]: https://opensource.creativecommons.org/contributing-code/python-guidelines/
 [black]: https://github.com/psf/black

__init__.py

@@ -6,6 +6,7 @@
 import os
 import re
 import sys
+import traceback
 import warnings
 
 # Third-party
@@ -16,19 +17,16 @@
 import seaborn as sns
 from wordcloud import STOPWORDS, WordCloud  # noqa: E402
 
+sys.path.append(".")
 # First-party/Local
-import quantify
+import quantify  # noqa: E402
 
 # Warning suppression /!\ Caution /!\
 warnings.filterwarnings("ignore")
 
 # Setup PATH_WORK_DIR, and LOGGER using quantify.setup()
-sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), "..")))
 _, PATH_WORK_DIR, _, _, LOGGER = quantify.setup(__file__)
 
-# Set the current working directory
-CWD = os.path.dirname(os.path.abspath(__file__))
-
 
 def tags_frequency(csv_path, column_names):
     """
@@ -527,11 +525,11 @@ def main():
     try:
         main()
     except SystemExit as e:
-        LOGGER.error("System exit with code: %d", e.code)
+        LOGGER.error(f"System exit with code: {e.code}")
         sys.exit(e.code)
     except KeyboardInterrupt:
-        LOGGER.info("Halted via KeyboardInterrupt.")
+        LOGGER.info("(130) Halted via KeyboardInterrupt.")
         sys.exit(130)
     except Exception:
-        LOGGER.exception("Unhandled exception:")
+        LOGGER.exception(f"(1) Unhandled exception: {traceback.format_exc()}")
         sys.exit(1)

analyze/data_analysis.py

@@ -4,9 +4,9 @@
 data.
 """
 # Standard library
-import logging
 import os
 import sys
+import traceback
 
 # Third-party
 import pandas as pd
@@ -15,11 +15,11 @@
 from requests.adapters import HTTPAdapter
 from urllib3.util.retry import Retry
 
+sys.path.append(".")
 # First-party/Local
-import quantify
+import quantify  # noqa: E402
 
 # Setup paths, Date and LOGGER using quantify.setup()
-sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), "..")))
 PATH_REPO_ROOT, PATH_WORK_DIR, PATH_DOTENV, DATETIME_TODAY, LOGGER = (
     quantify.setup(__file__)
 )
@@ -36,30 +36,14 @@
 PSE_KEY = os.getenv("PSE_KEY")
 
 # Set up file path for CSV report
-DATA_WRITE_FILE = (
-    f"{PATH_WORK_DIR}"
+DATA_WRITE_FILE = os.path.join(
+    PATH_WORK_DIR,
     f"/data_deviantart_"
-    f"{DATETIME_TODAY.year}_{DATETIME_TODAY.month}_{DATETIME_TODAY.day}.csv"
+    f"{DATETIME_TODAY.year}_{DATETIME_TODAY.month}_{DATETIME_TODAY.day}.csv",
 )
 
-# Set up the logger
-LOG = logging.getLogger(__name__)
-LOG.setLevel(logging.INFO)
-
-# Define both the handler and the formatter
-handler = logging.StreamHandler()
-formatter = logging.Formatter(
-    "%(asctime)s - %(levelname)s - %(name)s - %(message)s"
-)
-
-# Add formatter to the handler
-handler.setFormatter(formatter)
-
-# Add handler to the logger
-LOG.addHandler(handler)
-
 # Log the start of the script execution
-LOG.info("Script execution started.")
+LOGGER.info("Script execution started.")
 
 
 def get_license_list():
@@ -71,7 +55,7 @@ def get_license_list():
             An np array containing all license types that should be searched
             via Programmable Search Engine (PSE).
     """
-    LOG.info("Retrieving list of license from Creative Commons' record.")
+    LOGGER.info("Retrieving list of license from Creative Commons' record.")
 
     # Read license data from file
     cc_license_data = pd.read_csv(
@@ -98,7 +82,9 @@ def get_request_url(license):
     Returns:
     - str: The API Endpoint URL for the query specified by parameters.
     """
-    LOG.info(f"Generating API Endpoint URL for specified license: {license}")
+    LOGGER.info(
+        f"Generating API Endpoint URL for specified license: {license}"
+    )
 
     try:
         api_key = API_KEYS[API_KEYS_IND]
@@ -127,7 +113,7 @@ def get_response_elems(license):
     - dict: A dictionary mapping metadata to its value provided from the API
     query.
     """
-    LOG.info("Making a request to the API and handling potential retries.")
+    LOGGER.info("Making a request to the API and handling potential retries.")
 
     try:
         # Make a request to the API and handle potential retries
@@ -174,7 +160,7 @@ def record_license_data(license_type):
             default None value stands for having no assumption about license
             type.
     """
-    LOG.info(
+    LOGGER.info(
         "Writing the row for license type %s to contain DeviantArt data",
         license_type,
     )
@@ -205,15 +191,14 @@ def main():
 
 
 if __name__ == "__main__":
-    # Exception Handling
     try:
         main()
     except SystemExit as e:
-        LOGGER.error("System exit with code: %d", e.code)
+        LOGGER.error(f"System exit with code: {e.code}")
         sys.exit(e.code)
     except KeyboardInterrupt:
-        LOGGER.info("Halted via KeyboardInterrupt.")
+        LOGGER.info("(130) Halted via KeyboardInterrupt.")
         sys.exit(130)
     except Exception:
-        LOGGER.exception("Unhandled exception:")
+        LOGGER.exception(f"(1) Unhandled exception: {traceback.format_exc()}")
         sys.exit(1)

deviantart/deviantart_scratcher.py

@@ -13,17 +13,17 @@
 """
 
 # Standard library
-import os
 import sys
+import traceback
 
 # Third-party
 import pandas as pd
 
+sys.path.append(".")
 # First-party/Local
-import quantify
+import quantify  # noqa: E402
 
 # Setup only LOGGER using quantify.setup()
-sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), "..")))
 _, _, _, _, LOGGER = quantify.setup(__file__)
 
 
@@ -105,15 +105,14 @@ def main():
 
 
 if __name__ == "__main__":
-    # Exception Handling
     try:
         main()
     except SystemExit as e:
-        LOGGER.error("System exit with code: %d", e.code)
+        LOGGER.error(f"System exit with code: {e.code}")
         sys.exit(e.code)
     except KeyboardInterrupt:
-        LOGGER.info("Halted via KeyboardInterrupt.")
+        LOGGER.info("(130) Halted via KeyboardInterrupt.")
         sys.exit(130)
     except Exception:
-        LOGGER.exception("Unhandled exception:")
+        LOGGER.exception(f"(1) Unhandled exception: {traceback.format_exc()}")
         sys.exit(1)

flickr/data_cleaning.py

@@ -5,42 +5,26 @@
 
 # Standard library
 import json
-import logging
 import os
 import sys
+import traceback
 
 # Third-party
 import flickrapi
 from dotenv import load_dotenv
 
+sys.path.append(".")
 # First-party/Local
-import quantify
+import quantify  # noqa: E402
 
 # Setup paths, and LOGGER using quantify.setup()
-sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), "..")))
 _, PATH_WORK_DIR, PATH_DOTENV, _, LOGGER = quantify.setup(__file__)
 
 # Load environment variables
 load_dotenv(PATH_DOTENV)
 
-# Set up the logger
-LOG = logging.getLogger(__name__)
-LOG.setLevel(logging.INFO)
-
-# Define both the handler and the formatter
-handler = logging.StreamHandler()
-formatter = logging.Formatter(
-    "%(asctime)s - %(levelname)s - %(name)s - %(message)s"
-)
-
-# Add formatter to the handler
-handler.setFormatter(formatter)
-
-# Add handler to the logger
-LOG.addHandler(handler)
-
 # Log the start of the script execution
-LOG.info("Script execution started.")
+LOGGER.info("Script execution started.")
 
 
 def main():
@@ -64,15 +48,14 @@ def main():
 
 
 if __name__ == "__main__":
-    # Exception Handling
     try:
         main()
     except SystemExit as e:
-        LOGGER.error("System exit with code: %d", e.code)
+        LOGGER.error(f"System exit with code: {e.code}")
         sys.exit(e.code)
     except KeyboardInterrupt:
-        LOGGER.info("Halted via KeyboardInterrupt.")
+        LOGGER.info("(130) Halted via KeyboardInterrupt.")
         sys.exit(130)
     except Exception:
-        LOGGER.exception("Unhandled exception:")
+        LOGGER.exception(f"(1) Unhandled exception: {traceback.format_exc()}")
         sys.exit(1)