Merge pull request #125 from rajdesai24/push_data_to_ccos

logging changes in push_data_to_ccos

Author: TimidRobot

normalize_repos/log.py

@@ -148,7 +148,8 @@ def set_up_logging():
 def reset_handler():
     """
     Reset the formatter on the handler on the root logger. This causes the next
-    call to the logger can repopulate them based on the new stack in a new file.
+    call to the logger can repopulate them based on the new stack in a new
+    file.
     """
 
     handlers = logging.root.handlers

push_data_to_ccos/get_community_team_data.py

@@ -6,14 +6,22 @@
 """
 
 # Standard library
+import logging
 import os
 
 # Third-party
 import asana
 
+# First-party/Local
+import log
+
 ASANA_CLIENT = asana.Client.access_token(os.environ["ADMIN_ASANA_TOKEN"])
 ASANA_PROJECT_GID = "1172465506923661"
 
+log.set_up_logging()
+logger = logging.getLogger("push_data_to_ccos")
+log.reset_handler()
+
 
 def generate_databag():
     """
@@ -49,15 +57,15 @@ def generate_databag():
         ]
     }
     """
-    print("Pulling from Asana and generating databag...")
+    logger.log(logging.INFO, "Pulling from Asana and generating databag...")
     databag = {"projects": [], "community_builders": []}
 
     members = ASANA_CLIENT.tasks.find_by_section(
         ASANA_PROJECT_GID, opt_fields=["name", "custom_fields"]
     )
-    print("    Team members pulled.")
+    logger.log(logging.INFO, "Team members pulled.")
 
-    print("    Processing team members...")
+    logger.log(logging.INFO, "Processing team members...")
     for member in members:
         if member["name"] == "":
             continue  # Sometimes blank names come up
@@ -92,8 +100,7 @@ def generate_databag():
                     )
                     break
 
-    print("    Done.")
-    print("Pull successful.")
+    logger.log(logging.INFO, "Done.")
     return databag
 
 

push_data_to_ccos/get_repo_data.py

@@ -1,38 +1,46 @@
 #!/usr/bin/env python3
 # vim: set fileencoding=utf-8:
 
+# Standard library
+import logging
+
 # Third-party
 import emoji
 import yaml
 from github import Github
 from github.GithubException import GithubException, UnknownObjectException
 
 # First-party/Local
+import log
 from push_data_via_git import GITHUB_ORGANIZATION, GITHUB_TOKEN
 
 CC_METADATA_FILE_NAME = ".cc-metadata.yml"
 
+log.set_up_logging()
+logger = logging.getLogger("push_data_to_ccos")
+log.reset_handler()
+
 
 def set_up_github_client():
-    print("Setting up GitHub client...")
+    logger.log(logging.INFO, "Setting up GitHub client...")
     github_client = Github(GITHUB_TOKEN)
     return github_client
 
 
 def get_cc_organization(github_client):
-    print("Getting CC's GitHub organization...")
+    logger.log(logging.INFO, "Getting CC's GitHub organization...")
     cc = github_client.get_organization(GITHUB_ORGANIZATION)
     return cc
 
 
 def get_repositories(organization):
-    print("Getting CC's repos...")
+    logger.log(logging.INFO, "Getting CC's repos...")
     repos = organization.get_repos()
     return repos
 
 
 def get_repo_github_data(repo):
-    print("\tGetting data for this repo...")
+    logger.log(logging.INFO, "Getting data for this repo...")
     repo_github_data = {
         "id": repo.id,
         "name": repo.name,
@@ -59,10 +67,10 @@ def get_repo_github_data(repo):
 
 
 def get_repo_cc_metadata(repo):
-    print("\tGetting CC metadata for this repo...")
+    logger.log(logging.INFO, "Getting CC metadata for this repo...")
     try:
         cc_metadata_file = repo.get_contents(CC_METADATA_FILE_NAME)
-    except (UnknownObjectException, GithubException) as e:
+    except (UnknownObjectException, GithubException):
         return {}
     cc_metadata = yaml.safe_load(cc_metadata_file.decoded_content)
     if "technologies" in cc_metadata:
@@ -79,7 +87,9 @@ def get_repo_data_list(repos):
     total = repos.totalCount
 
     for repo in repos:
-        print(f"Processing {count} of {total} – {repo.name}")
+        logger.log(
+            logging.INFO, f"Processing {count} of {total} – {repo.name}"
+        )
         if not repo.private:
             repo_cc_metadata = get_repo_cc_metadata(repo)
             is_engineering_project = repo_cc_metadata.get(
@@ -92,7 +102,9 @@ def get_repo_data_list(repos):
                 repo_data = {**repo_github_data, **repo_cc_metadata}
                 repo_data_list.append(repo_data)
             else:
-                print("\tNot an active engineering project, skipping")
+                logger.log(
+                    logging.INFO, "Not an active engineering project, skipping"
+                )
         count += 1
     return sorted(repo_data_list, key=lambda k: k["name"].lower())
 

push_data_to_ccos/log.py

@@ -0,0 +1 @@
+../normalize_repos/log.py

push_data_to_ccos/push_data_via_git.py

@@ -3,19 +3,22 @@
 
 # Standard library
 import json
+import logging
 import os
 
 # Third-party
 import git
 
+# First-party/Local
+import log
+
 GIT_USER_NAME = "CC creativecommons.github.io Bot"
 GIT_USER_EMAIL = "cc-creativecommons-github-io-bot@creativecommons.org"
 
 GITHUB_USERNAME = "cc-creativecommons-github-io-bot"
 GITHUB_ORGANIZATION = "creativecommons"
 GITHUB_REPO_NAME = "creativecommons.github.io-source"
 
-
 GITHUB_TOKEN = os.environ["ADMIN_GITHUB_TOKEN"]
 GITHUB_REPO_URL_WITH_CREDENTIALS = (
     f"https://{GITHUB_USERNAME}:{GITHUB_TOKEN}"
@@ -26,32 +29,36 @@
 GIT_WORKING_DIRECTORY = f"{WORKING_DIRECTORY}/{GITHUB_REPO_NAME}"
 JSON_FILE_DIRECTORY = f"{GIT_WORKING_DIRECTORY}/databags"
 
+log.set_up_logging()
+logger = logging.getLogger("push_data_to_ccos")
+log.reset_handler()
+
 
 def set_up_repo():
     if not os.path.isdir(GIT_WORKING_DIRECTORY):
-        print("Cloning repo...")
+        logger.log(logging.INFO, "Cloning repo...")
         repo = git.Repo.clone_from(
             url=GITHUB_REPO_URL_WITH_CREDENTIALS, to_path=GIT_WORKING_DIRECTORY
         )
     else:
-        print("Setting up repo...")
+        logger.log(logging.INFO, "Setting up repo...")
         repo = git.Repo(GIT_WORKING_DIRECTORY)
     origin = repo.remotes.origin
-    print("Pulling latest code...")
+    logger.log(logging.INFO, "Pulling latest code...")
     origin.pull()
     return f"{WORKING_DIRECTORY}/{GITHUB_REPO_NAME}"
 
 
 def set_up_git_user():
-    print("Setting up git user...")
+    logger.log(logging.INFO, "Setting up git user...")
     os.environ["GIT_AUTHOR_NAME"] = GIT_USER_NAME
     os.environ["GIT_AUTHOR_EMAIL"] = GIT_USER_EMAIL
     os.environ["GIT_COMMITTER_NAME"] = GIT_USER_NAME
     os.environ["GIT_COMMITTER_EMAIL"] = GIT_USER_EMAIL
 
 
 def generate_json_file(data, filename):
-    print("Generating JSON file...")
+    logger.log(logging.INFO, "Generating JSON file...")
     json_filename = f"{JSON_FILE_DIRECTORY}/{filename}"
     with open(json_filename, "w") as json_file:
         json.dump(data, json_file, sort_keys=True, indent=4)
@@ -65,10 +72,10 @@ def commit_and_push_changes(json_filename):
         repo.index.add(items=f"{json_filename}")
         repo.index.commit(message="Syncing new data changes.")
         origin = repo.remotes.origin
-        print("Pushing latest code...")
+        logger.log(logging.INFO, "Pushing latest code...")
         origin.push()
     else:
-        print("No changes to push...")
+        logger.log(logging.INFO, "No changes to push...")
 
 
 def push_data(data, filename):