Merge pull request #6 from cisagov/bug-unusable-package

bug-unusable-package

setup.py

@@ -84,18 +84,19 @@ def get_version(version_file):
     keywords="posture and exposure report",
     packages=find_packages(where="src"),
     package_dir={"": "src"},
-    package_data={"pe_reports": ["data/*.txt"]},
+    package_data={"pe_reports": ["data/shell/*.pptx"]},
     py_modules=[splitext(basename(path))[0] for path in glob("src/*.py")],
     include_package_data=True,
     install_requires=[
         "docopt",
         "glob2",
         "openpyxl",
         "pandas",
-        "schema",
-        "setuptools >= 24.2.0",
         "pymongo",
         "pymupdf",
+        "python-pptx",
+        "schema",
+        "setuptools >= 24.2.0",
     ],
     extras_require={
         "test": [

src/pe_reports/__init__.py

@@ -3,6 +3,7 @@
 # although this import is not directly used, it populates the value
 # package_name.__version__, which is used to get version information about this
 # Python package.
-# Third-Party Libraries
-from _version import __version__  # noqa: F401
-from report_generator import main  # noqa: F401
+
+from ._version import __version__  # noqa: F401
+
+__all__ = ["pages", "report_generator", "stylesheet"]

src/pe_reports/__main__.py

@@ -1,6 +1,5 @@
 """Code to run if this package is used as a Python module."""
 
-# Third-Party Libraries
-from report_generator import main  # noqa: F401
+from .report_generator import main
 
 main()

src/pe_reports/pages.py

@@ -1,11 +1,15 @@
 """Collect and distribute graphical data to readable charts in the presentation."""
 
+# Standard Python Libraries
+import logging
+
 # Third-Party Libraries
 import pandas as pd
 from pptx.chart.data import CategoryChartData
 from pptx.enum.chart import XL_CHART_TYPE
 from pptx.util import Inches
-from stylesheet import Graph, Paragraph
+
+from .stylesheet import Graph, Paragraph
 
 # Use the following function to locate "Text Box" element in slide.
 # find_shape = Paragraph.shapes_find(prs, slide)
@@ -14,137 +18,233 @@
 class Pages:
     """Class containing the presentation page information."""
 
+    @staticmethod
     def cover(prs):
         """Page 1: Cover page of presentation."""
         slide = prs.slides[0]
-        shape = Paragraph.shapes(prs, slide)
-        text_frame = Paragraph.text_frame(prs, shape)
+        shape = Paragraph.shapes(slide)
+        text_frame = Paragraph.text_frame(shape)
         frame = text_frame.paragraphs[0]
         run = frame.add_run()
-        df_customer = pd.read_csv("src/pe_reports/data/csv/dhs_customer.csv")
-        dates = (
-            df_customer.iloc[0]["start_date"] + " to " + df_customer.iloc[0]["end_date"]
-        )
-        run.text = (
-            "Prepared for: "
-            + str(df_customer.iloc[0]["name"])
-            + "\nReporting period: "
-            + str(dates)
-        )
-        font = run.font
-        font = Paragraph.text_style_title(prs, font)
+        try:
+            # TODO: Remove hard-coded file locations
+            # Issue 8: https://github.com/cisagov/pe-reports/issues/8
+            df_customer = pd.read_csv("src/pe_reports/data/csv/dhs_customer.csv")
+            dates = (
+                df_customer.iloc[0]["start_date"]
+                + " to "
+                + df_customer.iloc[0]["end_date"]
+            )
+            run.text = (
+                "Prepared for: "
+                + str(df_customer.iloc[0]["name"])
+                + "\nReporting period: "
+                + str(dates)
+            )
+            font = run.font
+            Paragraph.text_style_title(font)
+        except FileNotFoundError as not_found:
+            logging.error("%s : There is no customer data.", not_found)
+
         return prs
 
+    @staticmethod
     def overview(prs):
         """Page 2: Posture & Exposure Report Overview."""
         slide = prs.slides[1]
-        shape = Paragraph.shapes(prs, slide)
 
         # Overview Value - Credentials exposed in recent posts
-        ov_val_01 = Paragraph.text_frame_ov_val(prs, slide, shape, "TextBox 2")
+        ov_val_01 = Paragraph.text_frame_ov_val(slide, "TextBox 2")
         frame = ov_val_01.paragraphs[0]
         run = frame.add_run()
-        df_creds = pd.read_csv("src/pe_reports/data/csv/dhs_creds.csv")
-        run.text = str(int(df_creds.iloc[0]["count"]))
-        font = run.font
-        font = Paragraph.text_style_ov_val(prs, font)
+        try:
+            # TODO: Remove hard-coded file locations
+            # Issue 8: https://github.com/cisagov/pe-reports/issues/8
+            df_creds = pd.read_csv("src/pe_reports/data/csv/dhs_creds.csv")
+
+            # TODO: Dry out this code
+            # Issue 18: https://github.com/cisagov/pe-reports/issues/18
+            run.text = str(int(df_creds.iloc[0]["count"]))
+            font = run.font
+            Paragraph.text_style_ov_val(font)
+        except FileNotFoundError as not_found:
+            logging.error("%s : There is no customer data.", not_found)
 
         # Overview Value - Suspected domain masquerading alerts
-        ov_val_02 = Paragraph.text_frame_ov_val(prs, slide, shape, "TextBox 82")
+        ov_val_02 = Paragraph.text_frame_ov_val(slide, "TextBox 82")
         frame = ov_val_02.paragraphs[0]
         run = frame.add_run()
-        df_domains = pd.read_csv("src/pe_reports/data/csv/dhs_domains.csv")
-        run.text = str(int(df_domains.iloc[0]["count"]))
-        font = run.font
-        font = Paragraph.text_style_ov_val(prs, font)
+        try:
+            # TODO: Remove hard-coded file locations
+            # Issue 8: https://github.com/cisagov/pe-reports/issues/8
+            df_domains = pd.read_csv("src/pe_reports/data/csv/dhs_domains.csv")
+
+            # TODO: Dry out this code
+            # Issue 18: https://github.com/cisagov/pe-reports/issues/18
+            run.text = str(int(df_domains.iloc[0]["count"]))
+            font = run.font
+            Paragraph.text_style_ov_val(font)
+        except FileNotFoundError as not_found:
+            logging.error("%s : There is no customer data.", not_found)
 
         # Overview Value - Active malware associations
-        ov_val_03 = Paragraph.text_frame_ov_val(prs, slide, shape, "TextBox 86")
+        ov_val_03 = Paragraph.text_frame_ov_val(slide, "TextBox 86")
         frame = ov_val_03.paragraphs[0]
         run = frame.add_run()
-        df_malware = pd.read_csv("src/pe_reports/data/csv/dhs_malware.csv")
-        run.text = str(int(df_malware.iloc[0]["count"]))
-        font = run.font
-        font = Paragraph.text_style_ov_val(prs, font)
+        try:
+            # TODO: Remove hard-coded file locations
+            # Issue 8: https://github.com/cisagov/pe-reports/issues/8
+            df_malware = pd.read_csv("src/pe_reports/data/csv/dhs_malware.csv")
+
+            # TODO: Dry out this code
+            # Issue 18: https://github.com/cisagov/pe-reports/issues/18
+            run.text = str(int(df_malware.iloc[0]["count"]))
+            font = run.font
+            Paragraph.text_style_ov_val(font)
+        except FileNotFoundError as not_found:
+            logging.error("%s : There is no customer data.", not_found)
 
         # Overview Value - Web and dark web mentions
-        ov_val_04 = Paragraph.text_frame_ov_val(prs, slide, shape, "TextBox 87")
+        ov_val_04 = Paragraph.text_frame_ov_val(slide, "TextBox 87")
         frame = ov_val_04.paragraphs[0]
         run = frame.add_run()
-        df_vulns = pd.read_csv("src/pe_reports/data/csv/dhs_vulns.csv")
-        run.text = str(int(df_vulns.iloc[0]["count"]))
-        font = run.font
-        font = Paragraph.text_style_ov_val(prs, font)
+        try:
+            # TODO: Remove hard-coded file locations
+            # Issue 8: https://github.com/cisagov/pe-reports/issues/8
+            df_vulns = pd.read_csv("src/pe_reports/data/csv/dhs_vulns.csv")
+
+            # TODO: Dry out this code
+            # Issue 18: https://github.com/cisagov/pe-reports/issues/18
+            run.text = str(int(df_vulns.iloc[0]["count"]))
+            font = run.font
+            Paragraph.text_style_ov_val(font)
+        except FileNotFoundError as not_found:
+            logging.error("%s : There is no customer data.", not_found)
 
         # Overview Value - Credentials exposed in recent posts
-        ov_val_05 = Paragraph.text_frame_ov_val(prs, slide, shape, "TextBox 90")
+        ov_val_05 = Paragraph.text_frame_ov_val(slide, "TextBox 90")
         frame = ov_val_05.paragraphs[0]
         run = frame.add_run()
-        df_web = pd.read_csv("src/pe_reports/data/csv/dhs_web.csv")
-        run.text = str(int(df_web.iloc[0]["count"]))
-        font = run.font
-        font = Paragraph.text_style_ov_val(prs, font)
+        try:
+            df_web = pd.read_csv("src/pe_reports/data/csv/dhs_web.csv")
+
+            # TODO: Dry out this code
+            # Issue 18: https://github.com/cisagov/pe-reports/issues/18
+            run.text = str(int(df_web.iloc[0]["count"]))
+            font = run.font
+            Paragraph.text_style_ov_val(font)
+        except FileNotFoundError as not_found:
+            logging.error("%s : There is no customer data.", not_found)
 
         # Bar Graph - Top Level Domains used for masquerading
         chart = CategoryChartData()
-        tld_df = pd.read_csv("src/pe_reports/data/csv/dhs_tld_df.csv").fillna(0)
 
-        chart.categories = list(tld_df.columns.values)
-        chart.add_series("Top Level Domains", list(tld_df.loc[0]))
-        x, y, cx, cy = Inches(3.5), Inches(2.9), Inches(2), Inches(1.5)
-        chart = slide.shapes.add_chart(
-            XL_CHART_TYPE.COLUMN_STACKED, x, y, cx, cy, chart
-        ).chart
-        chart = Graph.bar_sm(prs, slide, chart)
+        # TODO: Dry out this code
+        # Issue 18: https://github.com/cisagov/pe-reports/issues/18
+        try:
+            # TODO: Remove hard-coded file locations
+            # Issue 8: https://github.com/cisagov/pe-reports/issues/8
+            tld_df = pd.read_csv("src/pe_reports/data/csv/dhs_tld_df.csv").fillna(0)
+            chart.categories = list(tld_df.columns.values)
+            chart.add_series("Top Level Domains", list(tld_df.loc[0]))
+
+            # TODO: Remove hard-coded graph size and positioning values
+            # Issue 9: https://github.com/cisagov/pe-reports/issues/9
+            x, y, cx, cy = Inches(3.5), Inches(2.9), Inches(2), Inches(1.5)
+            chart = slide.shapes.add_chart(
+                XL_CHART_TYPE.COLUMN_STACKED, x, y, cx, cy, chart
+            ).chart
+            Graph.chart_sm(chart)
+        except FileNotFoundError as not_found:
+            logging.error("%s : There is no customer data.", not_found)
 
         # Bar Graph - Sources of credential exposures
         chart = CategoryChartData()
-        ce_df = pd.read_csv("src/pe_reports/data/csv/dhs_ce_df.csv").fillna(0)
 
-        chart.categories = list(ce_df.columns.values)
-        chart.add_series("Top Level Domains", list(ce_df.loc[0]))
-        x, y, cx, cy = Inches(5.75), Inches(2.9), Inches(2), Inches(1.5)
-        chart = slide.shapes.add_chart(
-            XL_CHART_TYPE.COLUMN_STACKED, x, y, cx, cy, chart
-        ).chart
-        chart = Graph.bar_sm(prs, slide, chart)
+        # TODO: Dry out this code
+        # Issue 18: https://github.com/cisagov/pe-reports/issues/18
+        try:
+            # TODO: Remove hard-coded file locations
+            # Issue 8: https://github.com/cisagov/pe-reports/issues/8
+            ce_df = pd.read_csv("src/pe_reports/data/csv/dhs_ce_df.csv").fillna(0)
+            chart.categories = list(ce_df.columns.values)
+            chart.add_series("Top Level Domains", list(ce_df.loc[0]))
+
+            # TODO: Remove hard-coded graph size and positioning values
+            # Issue 9: https://github.com/cisagov/pe-reports/issues/9
+            x, y, cx, cy = Inches(5.75), Inches(2.9), Inches(2), Inches(1.5)
+            chart = slide.shapes.add_chart(
+                XL_CHART_TYPE.COLUMN_STACKED, x, y, cx, cy, chart
+            ).chart
+            Graph.chart_sm(chart)
+        except FileNotFoundError as not_found:
+            logging.error("%s : There is no customer data.", not_found)
 
         # Line Graph - Sources of credential exposures
         chart = CategoryChartData()
-        web_df = pd.read_csv("src/pe_reports/data/csv/dhs_web_df.csv").fillna(0)
 
-        chart.categories = list(web_df.columns.values)
-        chart.add_series("Web", list(web_df.loc[0]))
-        chart.add_series("Dark Web", list(web_df.loc[1]))
-
-        x, y, cx, cy = Inches(3.5), Inches(5), Inches(4.8), Inches(2.15)
-        chart = slide.shapes.add_chart(XL_CHART_TYPE.LINE, x, y, cx, cy, chart).chart
-        chart = Graph.line_med(prs, slide, chart)
+        # TODO: Dry out this code
+        # Issue 18: https://github.com/cisagov/pe-reports/issues/18
+        try:
+            # TODO: Remove hard-coded file locations
+            # Issue 8: https://github.com/cisagov/pe-reports/issues/8
+            web_df = pd.read_csv("src/pe_reports/data/csv/dhs_web_df.csv").fillna(0)
+            chart.categories = list(web_df.columns.values)
+            chart.add_series("Web", list(web_df.loc[0]))
+            chart.add_series("Dark Web", list(web_df.loc[1]))
+
+            # TODO: Remove hard-coded graph size and positioning values
+            # Issue 9: https://github.com/cisagov/pe-reports/issues/9
+            x, y, cx, cy = Inches(3.5), Inches(5), Inches(4.8), Inches(2.15)
+            chart = slide.shapes.add_chart(
+                XL_CHART_TYPE.LINE, x, y, cx, cy, chart
+            ).chart
+            Graph.chart_med(chart)
+        except FileNotFoundError as not_found:
+            logging.error("%s : There is no customer data.", not_found)
 
         # Bar Graph - Active malware associations
         chart = CategoryChartData()
 
-        ma_df = pd.read_csv("src/pe_reports/data/csv/dhs_ma_df.csv").fillna(0)
-
-        chart.categories = list(ma_df.columns.values)
-        chart.add_series("Sources", list(ma_df.loc[0]))
-
-        x, y, cx, cy = Inches(8.25), Inches(2.9), Inches(4.5), Inches(2.0)
-        chart = slide.shapes.add_chart(
-            XL_CHART_TYPE.COLUMN_STACKED_100, x, y, cx, cy, chart
-        ).chart
-        chart = Graph.bar_med_100(prs, slide, chart)
+        # TODO: Dry out this code
+        # Issue 18: https://github.com/cisagov/pe-reports/issues/18
+        try:
+            # TODO: Remove hard-coded file locations
+            # Issue 8: https://github.com/cisagov/pe-reports/issues/8
+            ma_df = pd.read_csv("src/pe_reports/data/csv/dhs_ma_df.csv").fillna(0)
+            chart.categories = list(ma_df.columns.values)
+            chart.add_series("Sources", list(ma_df.loc[0]))
+
+            # TODO: Remove hard-coded graph size and positioning values
+            # Issue 9: https://github.com/cisagov/pe-reports/issues/9
+            x, y, cx, cy = Inches(8.25), Inches(2.9), Inches(4.5), Inches(2.0)
+            chart = slide.shapes.add_chart(
+                XL_CHART_TYPE.COLUMN_STACKED_100, x, y, cx, cy, chart
+            ).chart
+            Graph.chart_sm(chart)
+        except FileNotFoundError as not_found:
+            logging.error("%s : There is no customer data.", not_found)
 
         # Bar Graph - inferred vulnerabilities found via external observation
         chart = CategoryChartData()
-        iv_df = pd.read_csv("src/pe_reports/data/csv/dhs_iv_df.csv").fillna(0)
-
-        chart.categories = list(iv_df.columns.values)
-        chart.add_series("Sources", list(iv_df.loc[0]))
 
-        x, y, cx, cy = Inches(8.25), Inches(4.9), Inches(4.5), Inches(2.0)
-        chart = slide.shapes.add_chart(
-            XL_CHART_TYPE.COLUMN_STACKED_100, x, y, cx, cy, chart
-        ).chart
-        chart = Graph.bar_med_100(prs, slide, chart)
+        # TODO: Dry out this code
+        # Issue 18: https://github.com/cisagov/pe-reports/issues/18
+        try:
+            # TODO: Remove hard-coded file locations
+            # Issue 8: https://github.com/cisagov/pe-reports/issues/8
+            iv_df = pd.read_csv("src/pe_reports/data/csv/dhs_iv_df.csv").fillna(0)
+
+            chart.categories = list(iv_df.columns.values)
+            chart.add_series("Sources", list(iv_df.loc[0]))
+
+            # TODO: Remove hard-coded graph size and positioning values
+            # Issue 9: https://github.com/cisagov/pe-reports/issues/9
+            x, y, cx, cy = Inches(8.25), Inches(4.9), Inches(4.5), Inches(2.0)
+            chart = slide.shapes.add_chart(
+                XL_CHART_TYPE.COLUMN_STACKED_100, x, y, cx, cy, chart
+            ).chart
+            Graph.chart_sm(chart)
+        except FileNotFoundError as not_found:
+            logging.error("%s : There is no customer data.", not_found)
         return prs