Merge pull request #10 from Qalthos/make_this_a_tool

Make this a package alternate approach

Author: NilashishC

.gitignore

@@ -2,3 +2,4 @@
 .vscode/
 *.code-workspace
 __pycache__/
+*.egg-info

README.md

@@ -2,7 +2,7 @@
 
 # Ansible Network Triager
 
-Set repositories of interest and run with `python -m triager -c /path/to/config.yaml`
+Set repositories of interest and run with `triager -c /path/to/config.yaml`
 
 This tool assists in weekly bug triages by fetching all issues and pull-requests 
 from repositories specified in the config file that were created (or updated) 
@@ -13,6 +13,10 @@ currently unassigned are pulled.
 By default, this prints out a table built from the fetched content to the console.
 When run with `--send-email` it also emails this table to all the listed maintainers.
 
+## Installation
+
+pip install git+https://github.com/ansible-network/ansible-network-triager.git@master
+
 ## Usage
 Options | Usage
 --- | ---
@@ -25,6 +29,7 @@ Options | Usage
 ## Notes
 - An example config file (example-config.yaml) has been placed in this repository for reference.
 - Tested with Python 3.6
+- This tool gets installed as a part of `ansible-network-tools` package.
 
 ## Licensing
 

setup.py

@@ -0,0 +1,14 @@
+from setuptools import setup
+
+setup(
+    name="ansible-network-tools",
+    version="1.0.0",
+    description="A set of utility tools for the Ansible Network Team",
+    url="http://github.com/ansible-network/ansible-network-triager",
+    author="Ansible Network Team",
+    license="GPLv3",
+    packages=["triager"],
+    install_requires=["pTable", "requests", "PyYAML"],
+    entry_points={"console_scripts": ["triager=triager.__main__:main"]},
+    zip_safe=False,
+)

triager/__init__.py

@@ -2,9 +2,11 @@
 import logging
 from datetime import datetime
 
+from triager import triager
+from triager.config import Config
 from triager.mailer import send_mail
+from triager.release import __ver__
 from triager.tablemaker import make_table
-from triager.triager import Triager
 
 
 def run(args):
@@ -17,23 +19,19 @@ def run(args):
             format="%(levelname)-10s%(message)s", level=logging_level
         )
 
-    triager = Triager(cfg=args.config_file)
-    issues = triager.triage()
+    config = Config(args.config_file)
+    issues = triager.triage(config)
 
     if issues:
         table = make_table(issues)
         logging.info("Printing triaged table to console")
         print(table)
 
-        if args.send_email is True:
-            send_mail(
-                content=table,
-                sender=triager.sender,
-                receivers=triager.maintainers,
-            )
+        if args.send_email is True and config.is_email_ready:
+            send_mail(content=table, config=config)
 
 
-if __name__ == "__main__":
+def main():
     parser = argparse.ArgumentParser(
         description="Triage issues and pull-requests from repositories of interest.",
         prog="Ansible Network Triager",
@@ -71,4 +69,17 @@ def run(args):
         help="send the triaged table as an email to the list of maintainers",
     )
 
-    run(parser.parse_args())
+    group.add_argument(
+        "--version", action="store_true", help="show version number",
+    )
+
+    args = parser.parse_args()
+
+    if args.version:
+        print("Ansible Network Triager, version {0}".format(__ver__))
+    else:
+        run(args)
+
+
+if __name__ == "__main__":
+    main()

triager/__main__.py

@@ -0,0 +1,75 @@
+import logging
+import os
+import sys
+from datetime import datetime, timedelta
+from email.headerregistry import Address
+
+import yaml
+
+
+class Config:
+    def __init__(self, cfg):
+        # select config.yaml from cwd
+        if not cfg:
+            logging.info("config file not specified, setting default")
+            cfg = "./config.yaml"
+
+        logging.info("attempting to read config file: {0}".format(cfg))
+
+        try:
+            with open(cfg, "r") as config_file:
+                config = yaml.safe_load(config_file)
+            logging.info("config file successfully loaded")
+        except FileNotFoundError as e:
+            logging.critical(e)
+            sys.exit()
+
+        logging.info("parsing information from config file")
+
+        # Populate org and repos to triage
+        self.repos = []
+        logging.debug("parsing orgs and repositories from config file")
+        for org in config["orgs"]:
+            for repo in org["repos"]:
+                self.repos.append((org["name"], repo))
+
+        # Populate maintainers list
+        logging.debug("parsing list of maintainers from config file")
+        self.maintainers = [
+            Address(item["name"], addr_spec=item["email"])
+            for item in config.get("maintainers", [])
+        ]
+
+        # Set address to send triage emails from
+        logging.debug("parsing triager email and password from config file")
+        self.sender = None
+        if "triager" in config:
+            try:
+                self.sender = {
+                    "email": config["triager"]["address"],
+                    "password": config["triager"]["password"],
+                }
+            except KeyError as exc:
+                logging.error(f"triager config malformed, key {exc!s} not found")
+            except TypeError:
+                logging.error("triager config malformed, should be a dictionary")
+        else:
+            logging.debug("triager not found in config, will not send email")
+
+        # Set last triage date
+        logging.debug("setting last triage date")
+        self.last_triage_date = datetime.utcnow() - timedelta(
+            days=int(config["timedelta"])
+        )
+
+        logging.info("config file successfully parsed")
+
+    @property
+    def token(self):
+        logging.debug("fetching oauth token")
+        if os.getenv("GH_TOKEN"):
+            return {"Authorization": "token {0}".format(os.getenv("GH_TOKEN"))}
+
+    @property
+    def is_email_ready(self):
+        return bool(self.sender and self.maintainers)

triager/config.py

@@ -1,43 +1,30 @@
 import logging
 import smtplib
 from datetime import date
-from email.headerregistry import Address
 from email.message import EmailMessage
 
 
-def send_mail(content, sender, receivers=[]):
+def send_mail(content, config):
     logging.info("attempting to send email to maintainers")
 
-    if not sender.get("email") or not sender.get("password"):
-        logging.critical(
-            "Triager email or password missing from config file, email could not be sent"
-        )
-    else:
-        msg = EmailMessage()
-        msg["From"] = sender["email"]
-        msg["To"] = _get_recipients(receivers)
-        msg["Subject"] = "Ansible Network Weekly Triage - {0}".format(
-            date.today().isoformat()
-        )
-        msg.set_content(str(content))
-        msg.add_alternative(
-            content.get_html_string(
-                attributes={"border": 1, "style": "text-align:center"}
-            ),
-            subtype="html",
-        )
+    msg = EmailMessage()
+    msg["From"] = config.sender["email"]
+    msg["To"] = config.maintainers
+    msg["Subject"] = "Ansible Network Weekly Triage - {0}".format(
+        date.today().isoformat()
+    )
+    msg.set_content(str(content))
+    msg.add_alternative(
+        content.get_html_string(
+            attributes={"border": 1, "style": "text-align:center"}
+        ),
+        subtype="html",
+    )
 
-        with smtplib.SMTP("smtp.gmail.com", 587) as smtp:
-            logging.info("attempting to send email")
-            smtp.starttls()
-            smtp.login(sender["email"], sender["password"])
-            smtp.send_message(msg)
+    with smtplib.SMTP("smtp.gmail.com", 587) as smtp:
+        logging.info("attempting to send email")
+        smtp.starttls()
+        smtp.login(config.sender["email"], config.sender["password"])
+        smtp.send_message(msg)
 
-        logging.info("email sent successfully")
-
-
-def _get_recipients(receivers):
-    logging.info("generating list of receipients")
-    return [
-        Address(item["name"], addr_spec=item["email"]) for item in receivers
-    ]
+    logging.info("email sent successfully")

triager/mailer.py

@@ -0,0 +1,2 @@
+__ver__ = "1.0.0"
+__author__ = "Ansible Network Team"

triager/release.py

@@ -1,103 +1,48 @@
 import logging
-import os
-import sys
-from datetime import datetime, timedelta
 
 import requests
-import yaml
 
-REQUEST_FMT = "https://api.github.com/repos/{0}/{1}/issues"
-
-
-class Triager:
-    def __init__(self, cfg):
-        self.oauth_token = os.getenv("GH_TOKEN")
-
-        # select config.yaml from cwd
-        if not cfg:
-            logging.info("config file not specified, setting default")
-            cfg = "./config.yaml"
 
-        logging.info("attempting to read config file: {0}".format(cfg))
-
-        try:
-            with open(cfg, "r") as config_file:
-                config = yaml.safe_load(config_file)
-            logging.info("config file successfully loaded")
-        except FileNotFoundError as e:
-            logging.critical(e)
-            sys.exit()
+REQUEST_FMT = "https://api.github.com/repos/{0}/{1}/issues"
 
-        logging.info("parsing information from config file")
 
-        # Populate org and repos to triage
-        self.repos = []
-        logging.debug("parsing orgs and repositories from config file")
-        for org in config["orgs"]:
-            for repo in org["repos"]:
-                self.repos.append((org["name"], repo))
+def triage(config):
+    issues = {}
+    for org, repo in config.repos:
+        repo_name = repo["name"]
+        repo_labels = repo.get("labels", [])
 
-        # Populate maintainers list
-        logging.debug("parsing list of maintainers from config file")
-        self.maintainers = config["maintainers"]
+        params = dict(since=config.last_triage_date.isoformat())
+        if repo_labels:
+            params["labels"] = ",".join(repo_labels)
+        else:
+            params["assignee"] = "none"
 
-        # Set address to send triage emails from
-        logging.debug("parsing triager email and password from config file")
-        self.sender = {
-            "email": config.get("triager", {}).get("address"),
-            "password": config.get("triager", {}).get("password"),
-        }
+        issues[repo_name] = []
 
-        # Set last triage date
-        logging.debug("setting last triage date")
-        self.last_triage_date = datetime.utcnow() - timedelta(
-            days=int(config["timedelta"])
+        logging.info(
+            "requesting issue details for {0}/{1}".format(org, repo_name)
+        )
+        resp = requests.get(
+            REQUEST_FMT.format(org, repo_name),
+            params=params,
+            headers=config.token,
         )
 
-        logging.info("config file successfully parsed")
-
-    def triage(self):
-        issues = {}
-        for org, repo in self.repos:
-            repo_name = repo["name"]
-            repo_labels = repo.get("labels", [])
-
-            params = dict(since=self.last_triage_date.isoformat())
-            if repo_labels:
-                params["labels"] = ",".join(repo_labels)
-            else:
-                params["assignee"] = "none"
-
-            issues[repo_name] = []
-
-            logging.info(
-                "requesting issue details for {0}/{1}".format(org, repo_name)
-            )
-            resp = requests.get(
-                REQUEST_FMT.format(org, repo_name),
-                params=params,
-                headers=self._get_token(),
+        if not resp.ok:
+            logging.critical(resp.json()["message"])
+            return {}
+
+        for item in resp.json():
+            issues[repo_name].append(
+                {
+                    "url": item["html_url"],
+                    "title": item["title"],
+                    "type": "Pull Request"
+                    if item.get("pull_request")
+                    else "Issue",
+                }
             )
 
-            if not resp.ok:
-                logging.critical(resp.json()["message"])
-                return {}
-
-            for item in resp.json():
-                issues[repo_name].append(
-                    {
-                        "url": item["html_url"],
-                        "title": item["title"],
-                        "type": "Pull Request"
-                        if item.get("pull_request")
-                        else "Issue",
-                    }
-                )
-
-        logging.info("triage successfully completed")
-        return issues
-
-    def _get_token(self):
-        logging.debug("fetching oauth token")
-        if self.oauth_token:
-            return {"Authorization": "token {0}".format(self.oauth_token)}
+    logging.info("triage successfully completed")
+    return issues